diff --git a/docs/GLOSSARY.html b/docs/GLOSSARY.html index 83b0786e32..735d958d59 100644 --- a/docs/GLOSSARY.html +++ b/docs/GLOSSARY.html @@ -2019,7 +2019,7 @@ diff --git a/docs/METHODS_EVENTS.html b/docs/METHODS_EVENTS.html index aaa4cfe08c..2242d7101b 100644 --- a/docs/METHODS_EVENTS.html +++ b/docs/METHODS_EVENTS.html @@ -2232,7 +2232,7 @@ diff --git a/docs/METHODS_EXTRINSICS.html b/docs/METHODS_EXTRINSICS.html index 76d91b8798..93b22a4c7f 100644 --- a/docs/METHODS_EXTRINSICS.html +++ b/docs/METHODS_EXTRINSICS.html @@ -2299,7 +2299,7 @@ diff --git a/docs/METHODS_RPC.html b/docs/METHODS_RPC.html index 352eb5e73a..15cbb387e0 100644 --- a/docs/METHODS_RPC.html +++ b/docs/METHODS_RPC.html @@ -2149,7 +2149,7 @@ diff --git a/docs/METHODS_STORAGE.html b/docs/METHODS_STORAGE.html index b7b4126201..f33fe30b9d 100644 --- a/docs/METHODS_STORAGE.html +++ b/docs/METHODS_STORAGE.html @@ -2526,7 +2526,7 @@ diff --git a/docs/api-derive/interfaces/_index_.derive.md b/docs/api-derive/interfaces/_index_.derive.md index c08182ed28..20fae5bbbd 100644 --- a/docs/api-derive/interfaces/_index_.derive.md +++ b/docs/api-derive/interfaces/_index_.derive.md @@ -12,7 +12,7 @@ **● balances**: *`ReturnTypes`<["balances/index"](../modules/_balances_index_.md)>* -*Defined in [index.ts:25](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/index.ts#L25)* +*Defined in [index.ts:25](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/index.ts#L25)* ___ @@ -21,7 +21,7 @@ ___ **● chain**: *`ReturnTypes`<["chain/index"](../modules/_chain_index_.md)>* -*Defined in [index.ts:26](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/index.ts#L26)* +*Defined in [index.ts:26](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/index.ts#L26)* ___ @@ -30,7 +30,7 @@ ___ **● democracy**: *`ReturnTypes`<["democracy/index"](../modules/_democracy_index_.md)>* -*Defined in [index.ts:27](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/index.ts#L27)* +*Defined in [index.ts:27](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/index.ts#L27)* ___ @@ -39,7 +39,7 @@ ___ **● session**: *`ReturnTypes`<["session/index"](../modules/_session_index_.md)>* -*Defined in [index.ts:28](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/index.ts#L28)* +*Defined in [index.ts:28](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/index.ts#L28)* ___ diff --git a/docs/api-derive/modules/_balances_accountidandindex_.md b/docs/api-derive/modules/_balances_accountidandindex_.md index b447751874..5bcee66503 100644 --- a/docs/api-derive/modules/_balances_accountidandindex_.md +++ b/docs/api-derive/modules/_balances_accountidandindex_.md @@ -8,7 +8,7 @@ **Ƭ IdAndIndex**: *[`AccountId` | `undefined`, `AccountIndex` | `undefined`]* -*Defined in [balances/accountIdAndIndex.ts:15](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/balances/accountIdAndIndex.ts#L15)* +*Defined in [balances/accountIdAndIndex.ts:15](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/balances/accountIdAndIndex.ts#L15)* ___ @@ -20,7 +20,7 @@ ___ ▸ **accountIdAndIndex**(api: *`ApiRx`*): `(Anonymous function)` -*Defined in [balances/accountIdAndIndex.ts:17](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/balances/accountIdAndIndex.ts#L17)* +*Defined in [balances/accountIdAndIndex.ts:17](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/balances/accountIdAndIndex.ts#L17)* **Parameters:** diff --git a/docs/api-derive/modules/_balances_accountidtoindex_.md b/docs/api-derive/modules/_balances_accountidtoindex_.md index 068355ea83..87e808f3aa 100644 --- a/docs/api-derive/modules/_balances_accountidtoindex_.md +++ b/docs/api-derive/modules/_balances_accountidtoindex_.md @@ -8,7 +8,7 @@ ▸ **accountIdToIndex**(api: *`ApiRx`*): `(Anonymous function)` -*Defined in [balances/accountIdToIndex.ts:13](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/balances/accountIdToIndex.ts#L13)* +*Defined in [balances/accountIdToIndex.ts:13](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/balances/accountIdToIndex.ts#L13)* **Parameters:** diff --git a/docs/api-derive/modules/_balances_accountindexes_.md b/docs/api-derive/modules/_balances_accountindexes_.md index d91a235995..022225d492 100644 --- a/docs/api-derive/modules/_balances_accountindexes_.md +++ b/docs/api-derive/modules/_balances_accountindexes_.md @@ -8,7 +8,7 @@ **Ƭ AccountIndexes**: *`object`* -*Defined in [balances/accountIndexes.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/balances/accountIndexes.ts#L14)* +*Defined in [balances/accountIndexes.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/balances/accountIndexes.ts#L14)* #### Type declaration @@ -24,7 +24,7 @@ ___ ▸ **accountIndexes**(api: *`ApiRx`*): `(Anonymous function)` -*Defined in [balances/accountIndexes.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/balances/accountIndexes.ts#L16)* +*Defined in [balances/accountIndexes.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/balances/accountIndexes.ts#L16)* **Parameters:** diff --git a/docs/api-derive/modules/_balances_accountindextoid_.md b/docs/api-derive/modules/_balances_accountindextoid_.md index e2d8fef4d4..080510041a 100644 --- a/docs/api-derive/modules/_balances_accountindextoid_.md +++ b/docs/api-derive/modules/_balances_accountindextoid_.md @@ -8,7 +8,7 @@ ▸ **accountIndexToId**(api: *`ApiRx`*): `(Anonymous function)` -*Defined in [balances/accountIndexToId.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/balances/accountIndexToId.ts#L14)* +*Defined in [balances/accountIndexToId.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/balances/accountIndexToId.ts#L14)* **Parameters:** diff --git a/docs/api-derive/modules/_balances_fees_.md b/docs/api-derive/modules/_balances_fees_.md index 7f8a41cb18..880f014aad 100644 --- a/docs/api-derive/modules/_balances_fees_.md +++ b/docs/api-derive/modules/_balances_fees_.md @@ -8,7 +8,7 @@ ▸ **fees**(api: *`ApiRx`*): `(Anonymous function)` -*Defined in [balances/fees.ts:12](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/balances/fees.ts#L12)* +*Defined in [balances/fees.ts:12](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/balances/fees.ts#L12)* **Parameters:** diff --git a/docs/api-derive/modules/_balances_validatingbalance_.md b/docs/api-derive/modules/_balances_validatingbalance_.md index 7103cd8ad4..ac1910aede 100644 --- a/docs/api-derive/modules/_balances_validatingbalance_.md +++ b/docs/api-derive/modules/_balances_validatingbalance_.md @@ -8,7 +8,7 @@ ▸ **validatingBalance**(api: *`ApiRx`*): `(Anonymous function)` -*Defined in [balances/validatingBalance.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/balances/validatingBalance.ts#L16)* +*Defined in [balances/validatingBalance.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/balances/validatingBalance.ts#L16)* **Parameters:** diff --git a/docs/api-derive/modules/_balances_validatingbalances_.md b/docs/api-derive/modules/_balances_validatingbalances_.md index 99b6f09387..186ce64c45 100644 --- a/docs/api-derive/modules/_balances_validatingbalances_.md +++ b/docs/api-derive/modules/_balances_validatingbalances_.md @@ -8,7 +8,7 @@ ▸ **validatingBalances**(api: *`ApiRx`*): `(Anonymous function)` -*Defined in [balances/validatingBalances.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/balances/validatingBalances.ts#L14)* +*Defined in [balances/validatingBalances.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/balances/validatingBalances.ts#L14)* **Parameters:** diff --git a/docs/api-derive/modules/_balances_votingbalance_.md b/docs/api-derive/modules/_balances_votingbalance_.md index 94b63adb28..7803dfb266 100644 --- a/docs/api-derive/modules/_balances_votingbalance_.md +++ b/docs/api-derive/modules/_balances_votingbalance_.md @@ -8,7 +8,7 @@ ▸ **votingBalance**(api: *`ApiRx`*): `(Anonymous function)` -*Defined in [balances/votingBalance.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/balances/votingBalance.ts#L16)* +*Defined in [balances/votingBalance.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/balances/votingBalance.ts#L16)* **Parameters:** diff --git a/docs/api-derive/modules/_balances_votingbalances_.md b/docs/api-derive/modules/_balances_votingbalances_.md index 6fa23c5fd1..c0cd785bce 100644 --- a/docs/api-derive/modules/_balances_votingbalances_.md +++ b/docs/api-derive/modules/_balances_votingbalances_.md @@ -8,7 +8,7 @@ ▸ **votingBalances**(api: *`ApiRx`*): `(Anonymous function)` -*Defined in [balances/votingBalances.ts:13](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/balances/votingBalances.ts#L13)* +*Defined in [balances/votingBalances.ts:13](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/balances/votingBalances.ts#L13)* **Parameters:** diff --git a/docs/api-derive/modules/_balances_votingbalancesnominatorsfor_.md b/docs/api-derive/modules/_balances_votingbalancesnominatorsfor_.md index 11a56ae06d..ac2431b074 100644 --- a/docs/api-derive/modules/_balances_votingbalancesnominatorsfor_.md +++ b/docs/api-derive/modules/_balances_votingbalancesnominatorsfor_.md @@ -8,7 +8,7 @@ ▸ **votingBalancesNominatorsFor**(api: *`ApiRx`*): `(Anonymous function)` -*Defined in [balances/votingBalancesNominatorsFor.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/balances/votingBalancesNominatorsFor.ts#L14)* +*Defined in [balances/votingBalancesNominatorsFor.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/balances/votingBalancesNominatorsFor.ts#L14)* **Parameters:** diff --git a/docs/api-derive/modules/_chain_bestnumber_.md b/docs/api-derive/modules/_chain_bestnumber_.md index ec434ec5f5..cfae57a18e 100644 --- a/docs/api-derive/modules/_chain_bestnumber_.md +++ b/docs/api-derive/modules/_chain_bestnumber_.md @@ -8,7 +8,7 @@ ▸ **bestNumber**(api: *`ApiRx`*): `(Anonymous function)` -*Defined in [chain/bestNumber.ts:15](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/chain/bestNumber.ts#L15)* +*Defined in [chain/bestNumber.ts:15](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/chain/bestNumber.ts#L15)* Get the latest block number. diff --git a/docs/api-derive/modules/_chain_bestnumberfinalised_.md b/docs/api-derive/modules/_chain_bestnumberfinalised_.md index d020aaa54d..c0012d6687 100644 --- a/docs/api-derive/modules/_chain_bestnumberfinalised_.md +++ b/docs/api-derive/modules/_chain_bestnumberfinalised_.md @@ -8,7 +8,7 @@ ▸ **bestNumberFinalised**(api: *`ApiRx`*): `(Anonymous function)` -*Defined in [chain/bestNumberFinalised.ts:15](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/chain/bestNumberFinalised.ts#L15)* +*Defined in [chain/bestNumberFinalised.ts:15](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/chain/bestNumberFinalised.ts#L15)* Get the latest finalised block number. diff --git a/docs/api-derive/modules/_democracy_referenduminfos_.md b/docs/api-derive/modules/_democracy_referenduminfos_.md index 1530d417ee..6093ad142c 100644 --- a/docs/api-derive/modules/_democracy_referenduminfos_.md +++ b/docs/api-derive/modules/_democracy_referenduminfos_.md @@ -8,7 +8,7 @@ ▸ **referendumInfos**(api: *`ApiRx`*): `(Anonymous function)` -*Defined in [democracy/referendumInfos.ts:13](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/democracy/referendumInfos.ts#L13)* +*Defined in [democracy/referendumInfos.ts:13](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/democracy/referendumInfos.ts#L13)* **Parameters:** diff --git a/docs/api-derive/modules/_democracy_referendums_.md b/docs/api-derive/modules/_democracy_referendums_.md index 6b87c5f6f0..ca91d989e0 100644 --- a/docs/api-derive/modules/_democracy_referendums_.md +++ b/docs/api-derive/modules/_democracy_referendums_.md @@ -8,7 +8,7 @@ ▸ **referendums**(api: *`ApiRx`*): `(Anonymous function)` -*Defined in [democracy/referendums.ts:13](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/democracy/referendums.ts#L13)* +*Defined in [democracy/referendums.ts:13](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/democracy/referendums.ts#L13)* **Parameters:** diff --git a/docs/api-derive/modules/_democracy_referendumvotesfor_.md b/docs/api-derive/modules/_democracy_referendumvotesfor_.md index bc9eddd0a3..c95fda8ec8 100644 --- a/docs/api-derive/modules/_democracy_referendumvotesfor_.md +++ b/docs/api-derive/modules/_democracy_referendumvotesfor_.md @@ -8,7 +8,7 @@ ▸ **referendumVotesFor**(api: *`ApiRx`*): `(Anonymous function)` -*Defined in [democracy/referendumVotesFor.ts:17](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/democracy/referendumVotesFor.ts#L17)* +*Defined in [democracy/referendumVotesFor.ts:17](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/democracy/referendumVotesFor.ts#L17)* **Parameters:** diff --git a/docs/api-derive/modules/_democracy_votes_.md b/docs/api-derive/modules/_democracy_votes_.md index fcf941290f..349ce9e2f1 100644 --- a/docs/api-derive/modules/_democracy_votes_.md +++ b/docs/api-derive/modules/_democracy_votes_.md @@ -8,7 +8,7 @@ ▸ **votes**(api: *`ApiRx`*): `(Anonymous function)` -*Defined in [democracy/votes.ts:12](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/democracy/votes.ts#L12)* +*Defined in [democracy/votes.ts:12](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/democracy/votes.ts#L12)* **Parameters:** diff --git a/docs/api-derive/modules/_index_.md b/docs/api-derive/modules/_index_.md index f5742abc45..7539984b4f 100644 --- a/docs/api-derive/modules/_index_.md +++ b/docs/api-derive/modules/_index_.md @@ -20,7 +20,7 @@ ▸ **decorateDerive**(api: *`ApiRx`*): [Derive](../interfaces/_index_.derive.md) -*Defined in [index.ts:31](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/index.ts#L31)* +*Defined in [index.ts:31](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/index.ts#L31)* **Parameters:** diff --git a/docs/api-derive/modules/_session_eralength_.md b/docs/api-derive/modules/_session_eralength_.md index f3a2883342..ce0045aed0 100644 --- a/docs/api-derive/modules/_session_eralength_.md +++ b/docs/api-derive/modules/_session_eralength_.md @@ -8,7 +8,7 @@ ▸ **eraLength**(api: *`ApiRx`*): `(Anonymous function)` -*Defined in [session/eraLength.ts:13](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/session/eraLength.ts#L13)* +*Defined in [session/eraLength.ts:13](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/session/eraLength.ts#L13)* **Parameters:** diff --git a/docs/api-derive/modules/_session_eraprogress_.md b/docs/api-derive/modules/_session_eraprogress_.md index c15f884022..bad3c404e5 100644 --- a/docs/api-derive/modules/_session_eraprogress_.md +++ b/docs/api-derive/modules/_session_eraprogress_.md @@ -8,7 +8,7 @@ ▸ **eraProgress**(api: *`ApiRx`*): `(Anonymous function)` -*Defined in [session/eraProgress.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/session/eraProgress.ts#L14)* +*Defined in [session/eraProgress.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/session/eraProgress.ts#L14)* **Parameters:** diff --git a/docs/api-derive/modules/_session_sessionprogress_.md b/docs/api-derive/modules/_session_sessionprogress_.md index 8f93925143..3626f798e1 100644 --- a/docs/api-derive/modules/_session_sessionprogress_.md +++ b/docs/api-derive/modules/_session_sessionprogress_.md @@ -8,7 +8,7 @@ ▸ **sessionProgress**(api: *`ApiRx`*): `(Anonymous function)` -*Defined in [session/sessionProgress.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/session/sessionProgress.ts#L14)* +*Defined in [session/sessionProgress.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/session/sessionProgress.ts#L14)* **Parameters:** diff --git a/docs/api-derive/modules/_types_.md b/docs/api-derive/modules/_types_.md index a1c16d2cb6..c14358d386 100644 --- a/docs/api-derive/modules/_types_.md +++ b/docs/api-derive/modules/_types_.md @@ -8,7 +8,7 @@ **Ƭ DerivedBalances**: *`object`* -*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/types.ts#L7)* #### Type declaration @@ -19,7 +19,7 @@ ___ **Ƭ DerivedBalancesMap**: *`object`* -*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/types.ts#L17)* #### Type declaration @@ -32,7 +32,7 @@ ___ **Ƭ DerivedReferendumVote**: *`object`* -*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/types.ts#L21)* #### Type declaration diff --git a/docs/api-derive/modules/_util_cache_.md b/docs/api-derive/modules/_util_cache_.md index 99c3a68dff..4b268840a2 100644 --- a/docs/api-derive/modules/_util_cache_.md +++ b/docs/api-derive/modules/_util_cache_.md @@ -8,7 +8,7 @@ ▸ **cache**(fn: *`Function`*, map?: *`WeakMap`<`object`, `any`>*): `(Anonymous function)` -*Defined in [util/cache.ts:23](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api-derive/src/util/cache.ts#L23)* +*Defined in [util/cache.ts:23](https://github.com/polkadot-js/api/blob/132a8dd/packages/api-derive/src/util/cache.ts#L23)* Create memoization for a 2-currified function. diff --git a/docs/api/classes/_base_.apibase.md b/docs/api/classes/_base_.apibase.md index 3b78468129..0b2e1809e9 100644 --- a/docs/api/classes/_base_.apibase.md +++ b/docs/api/classes/_base_.apibase.md @@ -24,7 +24,7 @@ ⊕ **new ApiBase**(provider?: *[ApiOptions](../interfaces/_types_.apioptions.md) | `ProviderInterface`*): [ApiBase](_base_.apibase.md) -*Defined in [Base.ts:38](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L38)* +*Defined in [Base.ts:38](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L38)* *__description__*: Create an instance of the class @@ -58,7 +58,7 @@ ___ getgenesisHash(): `Hash` -*Defined in [Base.ts:77](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L77)* +*Defined in [Base.ts:77](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L77)* *__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions. @@ -71,7 +71,7 @@ ___ gethasSubscriptions(): `boolean` -*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L86)* +*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L86)* *__description__*: `true` when subscriptions are supported @@ -84,7 +84,7 @@ ___ getquery(): `S` -*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L122)* +*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L122)* *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. @@ -107,7 +107,7 @@ ___ getrpc(): `R` -*Defined in [Base.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L142)* +*Defined in [Base.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L142)* *__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime. @@ -130,7 +130,7 @@ ___ getruntimeMetadata(): `Metadata` -*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L93)* +*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L93)* *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. @@ -143,7 +143,7 @@ ___ getruntimeVersion(): `RuntimeVersion` -*Defined in [Base.ts:102](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L102)* +*Defined in [Base.ts:102](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L102)* *__description__*: Contains the version information for the current runtime. @@ -156,7 +156,7 @@ ___ gettx(): `E` -*Defined in [Base.ts:161](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L161)* +*Defined in [Base.ts:161](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L161)* *__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata. @@ -183,7 +183,7 @@ ___ ▸ **on**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` -*Defined in [Base.ts:186](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L186)* +*Defined in [Base.ts:186](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L186)* *__description__*: Attach an eventemitter handler to listen to a specific event @@ -215,7 +215,7 @@ ___ ▸ **once**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` -*Defined in [Base.ts:211](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L211)* +*Defined in [Base.ts:211](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L211)* *__description__*: Attach an one-time eventemitter handler to listen to a specific event diff --git a/docs/api/classes/_promise_combinator_.combinator.md b/docs/api/classes/_promise_combinator_.combinator.md index cae8c003e5..66299a408b 100644 --- a/docs/api/classes/_promise_combinator_.combinator.md +++ b/docs/api/classes/_promise_combinator_.combinator.md @@ -12,7 +12,7 @@ ⊕ **new Combinator**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction) | [[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction), `Array`]>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [Combinator](_promise_combinator_.combinator.md) -*Defined in [promise/Combinator.ts:21](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/Combinator.ts#L21)* +*Defined in [promise/Combinator.ts:21](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/Combinator.ts#L21)* **Parameters:** @@ -33,7 +33,7 @@ ___ ▸ **unsubscribe**(): `void` -*Defined in [promise/Combinator.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/Combinator.ts#L67)* +*Defined in [promise/Combinator.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/Combinator.ts#L67)* **Returns:** `void` diff --git a/docs/api/classes/_promise_index_.apipromise.html b/docs/api/classes/_promise_index_.apipromise.html index 86faaa19ca..a7ab5b36ec 100644 --- a/docs/api/classes/_promise_index_.apipromise.html +++ b/docs/api/classes/_promise_index_.apipromise.html @@ -2062,7 +2062,7 @@

constructor

⊕ new ApiPromise(options?: ApiOptions | ProviderInterface): ApiPromise

Overrides ApiBase.constructor

-

Defined in promise/index.ts:135

+

Defined in promise/index.ts:135

description: Creates an instance of the ApiPromise class

example:

import Api from '@polkadot/api/promise';
@@ -2098,7 +2098,7 @@
 

genesisHash

getgenesisHash(): Hash

Inherited from ApiBase.genesisHash

-

Defined in Base.ts:77

+

Defined in Base.ts:77

description: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.

Returns: Hash


@@ -2106,14 +2106,14 @@

hasSubscriptions

gethasSubscriptions(): boolean

Inherited from ApiBase.hasSubscriptions

-

Defined in Base.ts:86

+

Defined in Base.ts:86

description: true when subscriptions are supported

Returns: boolean


isReady

getisReady(): Promise<ApiPromise>

-

Defined in promise/index.ts:170

+

Defined in promise/index.ts:170

description: Promise that returns the first time we are connected and loaded

Returns: Promise<ApiPromise>


@@ -2121,7 +2121,7 @@

query

getquery(): QueryableStorage

Inherited from ApiBase.query

-

Defined in Base.ts:122

+

Defined in Base.ts:122

description: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.

All calls inside the namespace, is denoted by section.method and may take an optional query parameter. As an example, api.query.timestamp.now() (current block timestamp) does not take parameters, while api.query.system.accountNonce(<accountId>) (retrieving the associated nonce for an account), takes the AccountId as a parameter.

example:

@@ -2135,7 +2135,7 @@

rpc

getrpc(): DecoratedRpc

Inherited from ApiBase.rpc

-

Defined in Base.ts:142

+

Defined in Base.ts:142

description: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic api.query and api.tx sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.

RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.

example:

@@ -2149,7 +2149,7 @@

runtimeMetadata

getruntimeMetadata(): Metadata

Inherited from ApiBase.runtimeMetadata

-

Defined in Base.ts:93

+

Defined in Base.ts:93

description: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.

Returns: Metadata


@@ -2157,7 +2157,7 @@

runtimeVersion

getruntimeVersion(): RuntimeVersion

Inherited from ApiBase.runtimeVersion

-

Defined in Base.ts:102

+

Defined in Base.ts:102

description: Contains the version information for the current runtime.

Returns: RuntimeVersion


@@ -2165,7 +2165,7 @@

tx

gettx(): SubmittableExtrinsics

Inherited from ApiBase.tx

-

Defined in Base.ts:161

+

Defined in Base.ts:161

description: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.

example:

api.tx.balances
@@ -2181,7 +2181,7 @@
 

combineLatest

▸ combineLatest(fns: Array<CombinatorFunction | [CombinatorFunction, Array]>, callback: CombinatorCallback): UnsubFunction

-

Defined in promise/index.ts:232

+

Defined in promise/index.ts:232

description: Creates a combinator that can be used to combine the latest results from multiple subscriptions

example:

const address = '5DTestUPts3kjeXSTMyerHihn1uwMfLj8vU8sqF7qYrFacT7';
@@ -2224,7 +2224,7 @@
 

on

▸ on(type: ApiInterface$Events, handler: function): this

Inherited from ApiBase.on

-

Defined in Base.ts:186

+

Defined in Base.ts:186

description: Attach an eventemitter handler to listen to a specific event

example:

api.on('connected', () => {
@@ -2263,7 +2263,7 @@
 

once

▸ once(type: ApiInterface$Events, handler: function): this

Inherited from ApiBase.once

-

Defined in Base.ts:211

+

Defined in Base.ts:211

description: Attach an one-time eventemitter handler to listen to a specific event

example:

api.once('connected', () => {
@@ -2301,7 +2301,7 @@
 

<Static> create

▸ create(options?: ApiOptions | ProviderInterface): Promise<ApiPromise>

-

Defined in promise/index.ts:133

+

Defined in promise/index.ts:133

description: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.

example:

import Api from '@polkadot/api/promise';
@@ -2377,7 +2377,7 @@
     
 
diff --git a/docs/api/classes/_promise_index_.apipromise.md b/docs/api/classes/_promise_index_.apipromise.md index 2987d18a7e..666ed2a095 100644 --- a/docs/api/classes/_promise_index_.apipromise.md +++ b/docs/api/classes/_promise_index_.apipromise.md @@ -106,7 +106,7 @@ ApiPromise.create().then((api) => { *Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [promise/index.ts:135](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/index.ts#L135)* +*Defined in [promise/index.ts:135](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/index.ts#L135)* *__description__*: Creates an instance of the ApiPromise class @@ -142,7 +142,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* -*Defined in [Base.ts:77](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L77)* +*Defined in [Base.ts:77](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L77)* *__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions. @@ -157,7 +157,7 @@ gethasSubscriptions(): `boolean` *Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)* -*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L86)* +*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L86)* *__description__*: `true` when subscriptions are supported @@ -170,7 +170,7 @@ ___ getisReady(): `Promise`<[ApiPromise](_promise_index_.apipromise.md)> -*Defined in [promise/index.ts:170](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/index.ts#L170)* +*Defined in [promise/index.ts:170](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/index.ts#L170)* *__description__*: Promise that returns the first time we are connected and loaded @@ -185,7 +185,7 @@ getquery(): [QueryableStorage](../interfaces/_promise_types_.queryablestorage.md *Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)* -*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L122)* +*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L122)* *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. @@ -210,7 +210,7 @@ getrpc(): [DecoratedRpc](../interfaces/_promise_types_.decoratedrpc.md) *Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)* -*Defined in [Base.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L142)* +*Defined in [Base.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L142)* *__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime. @@ -235,7 +235,7 @@ getruntimeMetadata(): `Metadata` *Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)* -*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L93)* +*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L93)* *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. @@ -250,7 +250,7 @@ getruntimeVersion(): `RuntimeVersion` *Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)* -*Defined in [Base.ts:102](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L102)* +*Defined in [Base.ts:102](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L102)* *__description__*: Contains the version information for the current runtime. @@ -265,7 +265,7 @@ gettx(): [SubmittableExtrinsics](../interfaces/_promise_types_.submittableextrin *Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)* -*Defined in [Base.ts:161](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L161)* +*Defined in [Base.ts:161](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L161)* *__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata. @@ -292,7 +292,7 @@ ___ ▸ **combineLatest**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction) | [[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction), `Array`]>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [UnsubFunction](../modules/_promise_types_.md#unsubfunction) -*Defined in [promise/index.ts:232](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/index.ts#L232)* +*Defined in [promise/index.ts:232](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/index.ts#L232)* *__description__*: Creates a combinator that can be used to combine the latest results from multiple subscriptions @@ -329,7 +329,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)* -*Defined in [Base.ts:186](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L186)* +*Defined in [Base.ts:186](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L186)* *__description__*: Attach an eventemitter handler to listen to a specific event @@ -363,7 +363,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)* -*Defined in [Base.ts:211](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L211)* +*Defined in [Base.ts:211](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L211)* *__description__*: Attach an one-time eventemitter handler to listen to a specific event @@ -395,7 +395,7 @@ ___ ▸ **create**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) | `ProviderInterface`*): `Promise`<[ApiPromise](_promise_index_.apipromise.md)> -*Defined in [promise/index.ts:133](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/index.ts#L133)* +*Defined in [promise/index.ts:133](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/index.ts#L133)* *__description__*: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance. diff --git a/docs/api/classes/_promise_submittableextrinsic_.submittableextrinsic.md b/docs/api/classes/_promise_submittableextrinsic_.submittableextrinsic.md index 7610e2ab5f..4a6ee38191 100644 --- a/docs/api/classes/_promise_submittableextrinsic_.submittableextrinsic.md +++ b/docs/api/classes/_promise_submittableextrinsic_.submittableextrinsic.md @@ -25,7 +25,7 @@ *Overrides Extrinsic.__constructor* -*Defined in [promise/SubmittableExtrinsic.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/SubmittableExtrinsic.ts#L16)* +*Defined in [promise/SubmittableExtrinsic.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/SubmittableExtrinsic.ts#L16)* **Parameters:** @@ -73,7 +73,7 @@ getType(): `E` *Inherited from Struct.Type* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -88,7 +88,7 @@ getargs(): `Array`<`Codec`> *Inherited from Extrinsic.args* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:71](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L71)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:71](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L71)* *__description__*: The arguments passed to for the call, exposes args so it is compatible with \[\[Method\]\] @@ -103,7 +103,7 @@ getcallIndex(): `Uint8Array` *Inherited from Extrinsic.callIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:78](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L78)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:78](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L78)* *__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method @@ -118,7 +118,7 @@ getdata(): `Uint8Array` *Inherited from Extrinsic.data* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L85)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L85)* *__description__*: The actual data for the Method @@ -135,7 +135,7 @@ getencodedLength(): `number` *Overrides Struct.encodedLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:92](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L92)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:92](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L92)* *__description__*: The length of the value when encoded as a Uint8Array @@ -150,7 +150,7 @@ gethash(): `Hash` *Inherited from Extrinsic.hash* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L101)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L101)* *__description__*: Convernience function, encodes the extrinsic and returns the actual hash @@ -165,7 +165,7 @@ getisSigned(): `boolean` *Inherited from Extrinsic.isSigned* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L110)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L110)* *__description__*: `true` id the extrinsic is signed @@ -180,7 +180,7 @@ getlength(): `number` *Inherited from Extrinsic.length* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:117](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L117)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:117](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L117)* *__description__*: The length of the encoded value @@ -195,7 +195,7 @@ getmeta(): `FunctionMetadata` *Inherited from Extrinsic.meta* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:124](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L124)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:124](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L124)* *__description__*: The \[\[FunctionMetadata\]\] that describes the extrinsic @@ -210,7 +210,7 @@ getmethod(): `Method` *Inherited from Extrinsic.method* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L131)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L131)* *__description__*: The \[\[Method\]\] this extrinsic wraps @@ -225,7 +225,7 @@ getsignature(): `ExtrinsicSignature` *Inherited from Extrinsic.signature* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:138](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L138)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:138](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L138)* *__description__*: The \[\[ExtrinsicSignature\]\] @@ -258,7 +258,7 @@ ___ *Inherited from Extrinsic.addSignature* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:145](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L145)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:145](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L145)* *__description__*: Add an \[\[ExtrinsicSignature\]\] to the extrinsic (already generated) @@ -351,7 +351,7 @@ ___ *Overrides Map.get* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -372,7 +372,7 @@ ___ *Inherited from Struct.getAtIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -425,7 +425,7 @@ ___ ▸ **send**(statusCb?: *`undefined` | `function`*): `Promise`<`Hash`> | [UnsubFunction](../modules/_promise_types_.md#unsubfunction) -*Defined in [promise/SubmittableExtrinsic.ts:44](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/SubmittableExtrinsic.ts#L44)* +*Defined in [promise/SubmittableExtrinsic.ts:44](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/SubmittableExtrinsic.ts#L44)* **Parameters:** @@ -464,7 +464,7 @@ ___ *Overrides Extrinsic.sign* -*Defined in [promise/SubmittableExtrinsic.ts:52](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/SubmittableExtrinsic.ts#L52)* +*Defined in [promise/SubmittableExtrinsic.ts:52](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/SubmittableExtrinsic.ts#L52)* **Parameters:** @@ -483,7 +483,7 @@ ___ ▸ **signAndSend**(signerPair: *`KeyringPair`*, statusCb: *`function`*): `Promise`<`Hash`> | [UnsubFunction](../modules/_promise_types_.md#unsubfunction) -*Defined in [promise/SubmittableExtrinsic.ts:58](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/SubmittableExtrinsic.ts#L58)* +*Defined in [promise/SubmittableExtrinsic.ts:58](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/SubmittableExtrinsic.ts#L58)* **Parameters:** @@ -503,7 +503,7 @@ ___ *Inherited from Struct.toArray* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -520,7 +520,7 @@ ___ *Overrides Struct.toHex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:163](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L163)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:163](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L163)* *__description__*: Returns a hex string representation of the value @@ -537,7 +537,7 @@ ___ *Overrides Struct.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:170](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L170)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:170](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L170)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -552,7 +552,7 @@ ___ *Inherited from Struct.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -569,7 +569,7 @@ ___ *Overrides Struct.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:178](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L178)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:178](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L178)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -605,7 +605,7 @@ ___ *Inherited from Extrinsic.decodeExtrinsic* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L44)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L44)* **Parameters:** @@ -624,7 +624,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/api/classes/_rx_index_.apirx.html b/docs/api/classes/_rx_index_.apirx.html index e4793257fd..8bf30e0295 100644 --- a/docs/api/classes/_rx_index_.apirx.html +++ b/docs/api/classes/_rx_index_.apirx.html @@ -2073,7 +2073,7 @@

constructor

⊕ new ApiRx(options?: ApiOptions | ProviderInterface): ApiRx

Overrides ApiBase.constructor

-

Defined in rx/index.ts:145

+

Defined in rx/index.ts:145

description: Create an instance of the ApiRx class

example:

import Api from '@polkadot/api/rx';
@@ -2108,14 +2108,14 @@
 

derive

getderive(): Derive

-

Defined in rx/index.ts:181

+

Defined in rx/index.ts:181

Returns: Derive


genesisHash

getgenesisHash(): Hash

Inherited from ApiBase.genesisHash

-

Defined in Base.ts:77

+

Defined in Base.ts:77

description: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.

Returns: Hash


@@ -2123,21 +2123,21 @@

hasSubscriptions

gethasSubscriptions(): boolean

Inherited from ApiBase.hasSubscriptions

-

Defined in Base.ts:86

+

Defined in Base.ts:86

description: true when subscriptions are supported

Returns: boolean


isConnected

getisConnected(): Observable<boolean>

-

Defined in rx/index.ts:188

+

Defined in rx/index.ts:188

description: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.

Returns: Observable<boolean>


isReady

getisReady(): Observable<ApiRx>

-

Defined in rx/index.ts:195

+

Defined in rx/index.ts:195

description: Observable that returns the first time we are connected and loaded

Returns: Observable<ApiRx>


@@ -2145,7 +2145,7 @@

query

getquery(): QueryableStorage

Inherited from ApiBase.query

-

Defined in Base.ts:122

+

Defined in Base.ts:122

description: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.

All calls inside the namespace, is denoted by section.method and may take an optional query parameter. As an example, api.query.timestamp.now() (current block timestamp) does not take parameters, while api.query.system.accountNonce(<accountId>) (retrieving the associated nonce for an account), takes the AccountId as a parameter.

example:

@@ -2159,7 +2159,7 @@

rpc

getrpc(): RpcRx

Inherited from ApiBase.rpc

-

Defined in Base.ts:142

+

Defined in Base.ts:142

description: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic api.query and api.tx sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.

RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.

example:

@@ -2173,7 +2173,7 @@

runtimeMetadata

getruntimeMetadata(): Metadata

Inherited from ApiBase.runtimeMetadata

-

Defined in Base.ts:93

+

Defined in Base.ts:93

description: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.

Returns: Metadata


@@ -2181,7 +2181,7 @@

runtimeVersion

getruntimeVersion(): RuntimeVersion

Inherited from ApiBase.runtimeVersion

-

Defined in Base.ts:102

+

Defined in Base.ts:102

description: Contains the version information for the current runtime.

Returns: RuntimeVersion


@@ -2189,7 +2189,7 @@

tx

gettx(): SubmittableExtrinsics

Inherited from ApiBase.tx

-

Defined in Base.ts:161

+

Defined in Base.ts:161

description: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.

example:

api.tx.balances
@@ -2206,7 +2206,7 @@
 

on

▸ on(type: ApiInterface$Events, handler: function): this

Inherited from ApiBase.on

-

Defined in Base.ts:186

+

Defined in Base.ts:186

description: Attach an eventemitter handler to listen to a specific event

example:

api.on('connected', () => {
@@ -2245,7 +2245,7 @@
 

once

▸ once(type: ApiInterface$Events, handler: function): this

Inherited from ApiBase.once

-

Defined in Base.ts:211

+

Defined in Base.ts:211

description: Attach an one-time eventemitter handler to listen to a specific event

example:

api.once('connected', () => {
@@ -2283,7 +2283,7 @@
 

<Static> create

▸ create(options?: ApiOptions | ProviderInterface): Observable<ApiRx>

-

Defined in rx/index.ts:143

+

Defined in rx/index.ts:143

description: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.

example:

import Api from '@polkadot/api/rx';
@@ -2357,7 +2357,7 @@
     
 
diff --git a/docs/api/classes/_rx_index_.apirx.md b/docs/api/classes/_rx_index_.apirx.md index 48e84cce83..758f8a3e31 100644 --- a/docs/api/classes/_rx_index_.apirx.md +++ b/docs/api/classes/_rx_index_.apirx.md @@ -117,7 +117,7 @@ api.query.system *Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [rx/index.ts:145](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/rx/index.ts#L145)* +*Defined in [rx/index.ts:145](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/rx/index.ts#L145)* *__description__*: Create an instance of the ApiRx class @@ -151,7 +151,7 @@ ___ getderive(): `Derive` -*Defined in [rx/index.ts:181](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/rx/index.ts#L181)* +*Defined in [rx/index.ts:181](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/rx/index.ts#L181)* **Returns:** `Derive` @@ -164,7 +164,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* -*Defined in [Base.ts:77](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L77)* +*Defined in [Base.ts:77](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L77)* *__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions. @@ -179,7 +179,7 @@ gethasSubscriptions(): `boolean` *Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)* -*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L86)* +*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L86)* *__description__*: `true` when subscriptions are supported @@ -192,7 +192,7 @@ ___ getisConnected(): `Observable`<`boolean`> -*Defined in [rx/index.ts:188](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/rx/index.ts#L188)* +*Defined in [rx/index.ts:188](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/rx/index.ts#L188)* *__description__*: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity. @@ -205,7 +205,7 @@ ___ getisReady(): `Observable`<[ApiRx](_rx_index_.apirx.md)> -*Defined in [rx/index.ts:195](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/rx/index.ts#L195)* +*Defined in [rx/index.ts:195](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/rx/index.ts#L195)* *__description__*: Observable that returns the first time we are connected and loaded @@ -220,7 +220,7 @@ getquery(): [QueryableStorage](../interfaces/_rx_types_.queryablestorage.md) *Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)* -*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L122)* +*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L122)* *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. @@ -245,7 +245,7 @@ getrpc(): `RpcRx` *Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)* -*Defined in [Base.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L142)* +*Defined in [Base.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L142)* *__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime. @@ -270,7 +270,7 @@ getruntimeMetadata(): `Metadata` *Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)* -*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L93)* +*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L93)* *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. @@ -285,7 +285,7 @@ getruntimeVersion(): `RuntimeVersion` *Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)* -*Defined in [Base.ts:102](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L102)* +*Defined in [Base.ts:102](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L102)* *__description__*: Contains the version information for the current runtime. @@ -300,7 +300,7 @@ gettx(): [SubmittableExtrinsics](../interfaces/_rx_types_.submittableextrinsics. *Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)* -*Defined in [Base.ts:161](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L161)* +*Defined in [Base.ts:161](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L161)* *__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata. @@ -329,7 +329,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)* -*Defined in [Base.ts:186](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L186)* +*Defined in [Base.ts:186](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L186)* *__description__*: Attach an eventemitter handler to listen to a specific event @@ -363,7 +363,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)* -*Defined in [Base.ts:211](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/Base.ts#L211)* +*Defined in [Base.ts:211](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/Base.ts#L211)* *__description__*: Attach an one-time eventemitter handler to listen to a specific event @@ -395,7 +395,7 @@ ___ ▸ **create**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) | `ProviderInterface`*): `Observable`<[ApiRx](_rx_index_.apirx.md)> -*Defined in [rx/index.ts:143](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/rx/index.ts#L143)* +*Defined in [rx/index.ts:143](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/rx/index.ts#L143)* *__description__*: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance. diff --git a/docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md b/docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md index 07023c3347..0e536b11e9 100644 --- a/docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md +++ b/docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md @@ -25,7 +25,7 @@ *Overrides Extrinsic.__constructor* -*Defined in [rx/SubmittableExtrinsic.ts:17](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/rx/SubmittableExtrinsic.ts#L17)* +*Defined in [rx/SubmittableExtrinsic.ts:17](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/rx/SubmittableExtrinsic.ts#L17)* **Parameters:** @@ -73,7 +73,7 @@ getType(): `E` *Inherited from Struct.Type* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -88,7 +88,7 @@ getargs(): `Array`<`Codec`> *Inherited from Extrinsic.args* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:71](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L71)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:71](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L71)* *__description__*: The arguments passed to for the call, exposes args so it is compatible with \[\[Method\]\] @@ -103,7 +103,7 @@ getcallIndex(): `Uint8Array` *Inherited from Extrinsic.callIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:78](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L78)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:78](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L78)* *__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method @@ -118,7 +118,7 @@ getdata(): `Uint8Array` *Inherited from Extrinsic.data* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L85)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L85)* *__description__*: The actual data for the Method @@ -135,7 +135,7 @@ getencodedLength(): `number` *Overrides Struct.encodedLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:92](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L92)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:92](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L92)* *__description__*: The length of the value when encoded as a Uint8Array @@ -150,7 +150,7 @@ gethash(): `Hash` *Inherited from Extrinsic.hash* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L101)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L101)* *__description__*: Convernience function, encodes the extrinsic and returns the actual hash @@ -165,7 +165,7 @@ getisSigned(): `boolean` *Inherited from Extrinsic.isSigned* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L110)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L110)* *__description__*: `true` id the extrinsic is signed @@ -180,7 +180,7 @@ getlength(): `number` *Inherited from Extrinsic.length* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:117](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L117)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:117](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L117)* *__description__*: The length of the encoded value @@ -195,7 +195,7 @@ getmeta(): `FunctionMetadata` *Inherited from Extrinsic.meta* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:124](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L124)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:124](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L124)* *__description__*: The \[\[FunctionMetadata\]\] that describes the extrinsic @@ -210,7 +210,7 @@ getmethod(): `Method` *Inherited from Extrinsic.method* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L131)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L131)* *__description__*: The \[\[Method\]\] this extrinsic wraps @@ -225,7 +225,7 @@ getsignature(): `ExtrinsicSignature` *Inherited from Extrinsic.signature* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:138](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L138)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:138](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L138)* *__description__*: The \[\[ExtrinsicSignature\]\] @@ -258,7 +258,7 @@ ___ *Inherited from Extrinsic.addSignature* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:145](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L145)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:145](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L145)* *__description__*: Add an \[\[ExtrinsicSignature\]\] to the extrinsic (already generated) @@ -351,7 +351,7 @@ ___ *Overrides Map.get* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -372,7 +372,7 @@ ___ *Inherited from Struct.getAtIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -425,7 +425,7 @@ ___ ▸ **send**(): `Observable`<[SubmittableSendResult](../modules/_types_.md#submittablesendresult)> -*Defined in [rx/SubmittableExtrinsic.ts:47](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/rx/SubmittableExtrinsic.ts#L47)* +*Defined in [rx/SubmittableExtrinsic.ts:47](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/rx/SubmittableExtrinsic.ts#L47)* **Returns:** `Observable`<[SubmittableSendResult](../modules/_types_.md#submittablesendresult)> @@ -458,7 +458,7 @@ ___ *Overrides Extrinsic.sign* -*Defined in [rx/SubmittableExtrinsic.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/rx/SubmittableExtrinsic.ts#L53)* +*Defined in [rx/SubmittableExtrinsic.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/rx/SubmittableExtrinsic.ts#L53)* **Parameters:** @@ -477,7 +477,7 @@ ___ ▸ **signAndSend**(signerPair: *`KeyringPair`*): `Observable`<[SubmittableSendResult](../modules/_types_.md#submittablesendresult)> -*Defined in [rx/SubmittableExtrinsic.ts:59](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/rx/SubmittableExtrinsic.ts#L59)* +*Defined in [rx/SubmittableExtrinsic.ts:59](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/rx/SubmittableExtrinsic.ts#L59)* **Parameters:** @@ -496,7 +496,7 @@ ___ *Inherited from Struct.toArray* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -513,7 +513,7 @@ ___ *Overrides Struct.toHex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:163](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L163)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:163](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L163)* *__description__*: Returns a hex string representation of the value @@ -530,7 +530,7 @@ ___ *Overrides Struct.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:170](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L170)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:170](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L170)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -545,7 +545,7 @@ ___ *Inherited from Struct.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -562,7 +562,7 @@ ___ *Overrides Struct.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:178](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L178)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:178](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L178)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -598,7 +598,7 @@ ___ *Inherited from Extrinsic.decodeExtrinsic* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L44)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L44)* **Parameters:** @@ -617,7 +617,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/api/index.html b/docs/api/index.html index 4c94aafa05..5746161397 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -2088,7 +2088,7 @@
diff --git a/docs/api/interfaces/_promise_types_.apipromiseinterface.md b/docs/api/interfaces/_promise_types_.apipromiseinterface.md index 52466100e7..b540ef7714 100644 --- a/docs/api/interfaces/_promise_types_.apipromiseinterface.md +++ b/docs/api/interfaces/_promise_types_.apipromiseinterface.md @@ -20,7 +20,7 @@ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[genesisHash](_types_.apibaseinterface.md#genesishash)* -*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L13)* ___ @@ -31,7 +31,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[hasSubscriptions](_types_.apibaseinterface.md#hassubscriptions)* -*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L14)* ___ @@ -40,7 +40,7 @@ ___ **● isReady**: *`Promise`<[ApiPromiseInterface](_promise_types_.apipromiseinterface.md)>* -*Defined in [promise/types.ts:61](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/types.ts#L61)* +*Defined in [promise/types.ts:61](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/types.ts#L61)* ___ @@ -51,7 +51,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[on](_types_.apibaseinterface.md#on)* -*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L21)* #### Type declaration ▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` @@ -74,7 +74,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[once](_types_.apibaseinterface.md#once)* -*Defined in [types.ts:22](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L22)* #### Type declaration ▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` @@ -97,7 +97,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[query](_types_.apibaseinterface.md#query)* -*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L17)* ___ @@ -108,7 +108,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[rpc](_types_.apibaseinterface.md#rpc)* -*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L18)* ___ @@ -119,7 +119,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeMetadata](_types_.apibaseinterface.md#runtimemetadata)* -*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L15)* ___ @@ -130,7 +130,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeVersion](_types_.apibaseinterface.md#runtimeversion)* -*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L16)* ___ @@ -141,7 +141,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[tx](_types_.apibaseinterface.md#tx)* -*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L19)* ___ diff --git a/docs/api/interfaces/_promise_types_.decoratedrpc.md b/docs/api/interfaces/_promise_types_.decoratedrpc.md index 1d833cbc28..3a8ca72408 100644 --- a/docs/api/interfaces/_promise_types_.decoratedrpc.md +++ b/docs/api/interfaces/_promise_types_.decoratedrpc.md @@ -12,7 +12,7 @@ **● author**: *[DecoratedRpc$Section](_promise_types_.decoratedrpc_section.md)* -*Defined in [promise/types.ts:22](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/types.ts#L22)* +*Defined in [promise/types.ts:22](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/types.ts#L22)* ___ @@ -21,7 +21,7 @@ ___ **● chain**: *[DecoratedRpc$Section](_promise_types_.decoratedrpc_section.md)* -*Defined in [promise/types.ts:23](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/types.ts#L23)* +*Defined in [promise/types.ts:23](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/types.ts#L23)* ___ @@ -30,7 +30,7 @@ ___ **● state**: *[DecoratedRpc$Section](_promise_types_.decoratedrpc_section.md)* -*Defined in [promise/types.ts:24](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/types.ts#L24)* +*Defined in [promise/types.ts:24](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/types.ts#L24)* ___ @@ -39,7 +39,7 @@ ___ **● system**: *[DecoratedRpc$Section](_promise_types_.decoratedrpc_section.md)* -*Defined in [promise/types.ts:25](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/types.ts#L25)* +*Defined in [promise/types.ts:25](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/types.ts#L25)* ___ diff --git a/docs/api/interfaces/_promise_types_.queryablestoragefunction.md b/docs/api/interfaces/_promise_types_.queryablestoragefunction.md index cb04fee625..04bed29c26 100644 --- a/docs/api/interfaces/_promise_types_.queryablestoragefunction.md +++ b/docs/api/interfaces/_promise_types_.queryablestoragefunction.md @@ -15,7 +15,7 @@ ▸ **__call**(arg?: *`any`*): `Uint8Array` -*Defined in [promise/types.ts:33](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/types.ts#L33)* +*Defined in [promise/types.ts:33](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/types.ts#L33)* **Parameters:** @@ -25,7 +25,7 @@ **Returns:** [UnsubFunction](../modules/_promise_types_.md#unsubfunction) -*Defined in [promise/types.ts:34](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/types.ts#L34)* +*Defined in [promise/types.ts:34](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/types.ts#L34)* **Parameters:** @@ -36,7 +36,7 @@ **Returns:** [UnsubFunction](../modules/_promise_types_.md#unsubfunction) -*Defined in [promise/types.ts:35](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/types.ts#L35)* +*Defined in [promise/types.ts:35](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/types.ts#L35)* **Parameters:** @@ -46,7 +46,7 @@ **Returns:** `Promise`<`Codec` | `null` | `undefined`> -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageKey.ts#L12)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageKey.ts#L12)* **Parameters:** @@ -64,7 +64,7 @@ **● at**: *`function`* -*Defined in [promise/types.ts:37](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/types.ts#L37)* +*Defined in [promise/types.ts:37](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/types.ts#L37)* #### Type declaration ▸(hash: *`Hash`*, arg?: *`any`*): `Promise`<`Codec` | `null` | `undefined`> @@ -87,7 +87,7 @@ ___ *Inherited from StorageFunction.meta* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageKey.ts#L14)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageKey.ts#L14)* ___ @@ -98,7 +98,7 @@ ___ *Inherited from StorageFunction.method* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageKey.ts#L15)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageKey.ts#L15)* ___ @@ -109,7 +109,7 @@ ___ *Inherited from StorageFunction.section* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageKey.ts#L16)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageKey.ts#L16)* ___ @@ -120,7 +120,7 @@ ___ *Inherited from StorageFunction.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageKey.ts#L17)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageKey.ts#L17)* #### Type declaration ▸(): `any` diff --git a/docs/api/interfaces/_promise_types_.queryablestoragefunction_subscribe.md b/docs/api/interfaces/_promise_types_.queryablestoragefunction_subscribe.md index 606221ea1b..98a34587c5 100644 --- a/docs/api/interfaces/_promise_types_.queryablestoragefunction_subscribe.md +++ b/docs/api/interfaces/_promise_types_.queryablestoragefunction_subscribe.md @@ -9,7 +9,7 @@ ▸ **__call**(cb: *`function`*): [UnsubFunction](../modules/_promise_types_.md#unsubfunction) -*Defined in [promise/types.ts:28](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/types.ts#L28)* +*Defined in [promise/types.ts:28](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/types.ts#L28)* **Parameters:** @@ -20,7 +20,7 @@ **Returns:** [UnsubFunction](../modules/_promise_types_.md#unsubfunction) -*Defined in [promise/types.ts:29](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/types.ts#L29)* +*Defined in [promise/types.ts:29](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/types.ts#L29)* **Parameters:** diff --git a/docs/api/interfaces/_promise_types_.submittableextrinsicfunction.md b/docs/api/interfaces/_promise_types_.submittableextrinsicfunction.md index 378a0cf0d6..29e23362b1 100644 --- a/docs/api/interfaces/_promise_types_.submittableextrinsicfunction.md +++ b/docs/api/interfaces/_promise_types_.submittableextrinsicfunction.md @@ -11,7 +11,7 @@ ▸ **__call**(...args: *`any`[]*): `Method` -*Defined in [promise/types.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/types.ts#L48)* +*Defined in [promise/types.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/types.ts#L48)* **Parameters:** @@ -21,7 +21,7 @@ **Returns:** [SubmittableExtrinsic](../classes/_promise_submittableextrinsic_.submittableextrinsic.md) -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:28](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L28)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:28](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L28)* **Parameters:** @@ -41,7 +41,7 @@ *Inherited from MethodFunction.callIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:30](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L30)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:30](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L30)* ___ @@ -52,7 +52,7 @@ ___ *Inherited from MethodFunction.meta* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:31](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L31)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:31](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L31)* ___ @@ -63,7 +63,7 @@ ___ *Inherited from MethodFunction.method* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:32](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L32)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:32](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L32)* ___ @@ -74,7 +74,7 @@ ___ *Inherited from MethodFunction.section* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:33](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L33)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:33](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L33)* ___ @@ -85,7 +85,7 @@ ___ *Inherited from MethodFunction.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L34)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L34)* #### Type declaration ▸(): `any` diff --git a/docs/api/interfaces/_rx_types_.apirxinterface.md b/docs/api/interfaces/_rx_types_.apirxinterface.md index 7f3debe8ed..d0fe5a3a57 100644 --- a/docs/api/interfaces/_rx_types_.apirxinterface.md +++ b/docs/api/interfaces/_rx_types_.apirxinterface.md @@ -20,7 +20,7 @@ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[genesisHash](_types_.apibaseinterface.md#genesishash)* -*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L13)* ___ @@ -31,7 +31,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[hasSubscriptions](_types_.apibaseinterface.md#hassubscriptions)* -*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L14)* ___ @@ -40,7 +40,7 @@ ___ **● isConnected**: *`Observable`<`boolean`>* -*Defined in [rx/types.ts:42](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/rx/types.ts#L42)* +*Defined in [rx/types.ts:42](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/rx/types.ts#L42)* ___ @@ -49,7 +49,7 @@ ___ **● isReady**: *`Observable`<[ApiRxInterface](_rx_types_.apirxinterface.md)>* -*Defined in [rx/types.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/rx/types.ts#L43)* +*Defined in [rx/types.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/rx/types.ts#L43)* ___ @@ -60,7 +60,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[on](_types_.apibaseinterface.md#on)* -*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L21)* #### Type declaration ▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` @@ -83,7 +83,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[once](_types_.apibaseinterface.md#once)* -*Defined in [types.ts:22](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L22)* #### Type declaration ▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` @@ -106,7 +106,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[query](_types_.apibaseinterface.md#query)* -*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L17)* ___ @@ -117,7 +117,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[rpc](_types_.apibaseinterface.md#rpc)* -*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L18)* ___ @@ -128,7 +128,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeMetadata](_types_.apibaseinterface.md#runtimemetadata)* -*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L15)* ___ @@ -139,7 +139,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeVersion](_types_.apibaseinterface.md#runtimeversion)* -*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L16)* ___ @@ -150,7 +150,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[tx](_types_.apibaseinterface.md#tx)* -*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L19)* ___ diff --git a/docs/api/interfaces/_rx_types_.queryablestoragefunction.md b/docs/api/interfaces/_rx_types_.queryablestoragefunction.md index d363dc37fd..cc5a208484 100644 --- a/docs/api/interfaces/_rx_types_.queryablestoragefunction.md +++ b/docs/api/interfaces/_rx_types_.queryablestoragefunction.md @@ -11,7 +11,7 @@ ▸ **__call**(arg?: *`any`*): `Uint8Array` -*Defined in [rx/types.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/rx/types.ts#L16)* +*Defined in [rx/types.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/rx/types.ts#L16)* **Parameters:** @@ -21,7 +21,7 @@ **Returns:** `Observable`<`Codec` | `null` | `undefined`> -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageKey.ts#L12)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageKey.ts#L12)* **Parameters:** @@ -39,7 +39,7 @@ **● at**: *`function`* -*Defined in [rx/types.ts:18](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/rx/types.ts#L18)* +*Defined in [rx/types.ts:18](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/rx/types.ts#L18)* #### Type declaration ▸(hash: *`Hash`*, arg?: *`any`*): `Observable`<`Codec` | `null` | `undefined`> @@ -62,7 +62,7 @@ ___ *Inherited from StorageFunction.meta* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageKey.ts#L14)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageKey.ts#L14)* ___ @@ -73,7 +73,7 @@ ___ *Inherited from StorageFunction.method* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageKey.ts#L15)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageKey.ts#L15)* ___ @@ -84,7 +84,7 @@ ___ *Inherited from StorageFunction.section* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageKey.ts#L16)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageKey.ts#L16)* ___ @@ -95,7 +95,7 @@ ___ *Inherited from StorageFunction.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageKey.ts#L17)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageKey.ts#L17)* #### Type declaration ▸(): `any` diff --git a/docs/api/interfaces/_rx_types_.submittableextrinsicfunction.md b/docs/api/interfaces/_rx_types_.submittableextrinsicfunction.md index f926fedcaa..bda517bcd7 100644 --- a/docs/api/interfaces/_rx_types_.submittableextrinsicfunction.md +++ b/docs/api/interfaces/_rx_types_.submittableextrinsicfunction.md @@ -11,7 +11,7 @@ ▸ **__call**(...args: *`any`[]*): `Method` -*Defined in [rx/types.ts:29](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/rx/types.ts#L29)* +*Defined in [rx/types.ts:29](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/rx/types.ts#L29)* **Parameters:** @@ -21,7 +21,7 @@ **Returns:** [SubmittableExtrinsic](../classes/_rx_submittableextrinsic_.submittableextrinsic.md) -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:28](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L28)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:28](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L28)* **Parameters:** @@ -41,7 +41,7 @@ *Inherited from MethodFunction.callIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:30](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L30)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:30](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L30)* ___ @@ -52,7 +52,7 @@ ___ *Inherited from MethodFunction.meta* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:31](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L31)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:31](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L31)* ___ @@ -63,7 +63,7 @@ ___ *Inherited from MethodFunction.method* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:32](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L32)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:32](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L32)* ___ @@ -74,7 +74,7 @@ ___ *Inherited from MethodFunction.section* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:33](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L33)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:33](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L33)* ___ @@ -85,7 +85,7 @@ ___ *Inherited from MethodFunction.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L34)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L34)* #### Type declaration ▸(): `any` diff --git a/docs/api/interfaces/_types_.apibaseinterface.md b/docs/api/interfaces/_types_.apibaseinterface.md index cac1dddbe2..20ca0835fb 100644 --- a/docs/api/interfaces/_types_.apibaseinterface.md +++ b/docs/api/interfaces/_types_.apibaseinterface.md @@ -26,7 +26,7 @@ **● genesisHash**: *`Hash`* -*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L13)* ___ @@ -35,7 +35,7 @@ ___ **● hasSubscriptions**: *`boolean`* -*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L14)* ___ @@ -44,7 +44,7 @@ ___ **● on**: *`function`* -*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L21)* #### Type declaration ▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` @@ -65,7 +65,7 @@ ___ **● once**: *`function`* -*Defined in [types.ts:22](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L22)* #### Type declaration ▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` @@ -86,7 +86,7 @@ ___ **● query**: *`S`* -*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L17)* ___ @@ -95,7 +95,7 @@ ___ **● rpc**: *`R`* -*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L18)* ___ @@ -104,7 +104,7 @@ ___ **● runtimeMetadata**: *`Metadata`* -*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L15)* ___ @@ -113,7 +113,7 @@ ___ **● runtimeVersion**: *`RuntimeVersion`* -*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L16)* ___ @@ -122,7 +122,7 @@ ___ **● tx**: *`E`* -*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L19)* ___ diff --git a/docs/api/interfaces/_types_.apioptions.md b/docs/api/interfaces/_types_.apioptions.md index 364290e021..97c4153e7f 100644 --- a/docs/api/interfaces/_types_.apioptions.md +++ b/docs/api/interfaces/_types_.apioptions.md @@ -12,7 +12,7 @@ **● provider**: *`ProviderInterface`* -*Defined in [types.ts:30](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L30)* +*Defined in [types.ts:30](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L30)* *__description__*: Transport Provider from rpc-provider. If not specified, it will default to connecting to a WsProvider connecting localhost with the default port, i.e. `ws://127.0.0.1:9944` @@ -23,7 +23,7 @@ ___ **● types**: *`undefined` | `object`* -*Defined in [types.ts:35](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L35)* +*Defined in [types.ts:35](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L35)* *__description__*: Additional types used by runtime modules. This is nessusary if the runtime modules uses types not available in the base Substrate runtime. diff --git a/docs/api/modules/_promise_combinator_.md b/docs/api/modules/_promise_combinator_.md index 292236c1e7..89cce8488b 100644 --- a/docs/api/modules/_promise_combinator_.md +++ b/docs/api/modules/_promise_combinator_.md @@ -21,7 +21,7 @@ **Ƭ CombinatorCallback**: *`function`* -*Defined in [promise/Combinator.ts:9](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/Combinator.ts#L9)* +*Defined in [promise/Combinator.ts:9](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/Combinator.ts#L9)* #### Type declaration ▸(value: *`Array`<`any`>*): `any` @@ -41,7 +41,7 @@ ___ **Ƭ CombinatorFunction**: *`function`* -*Defined in [promise/Combinator.ts:10](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/Combinator.ts#L10)* +*Defined in [promise/Combinator.ts:10](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/Combinator.ts#L10)* #### Type declaration ▸(cb: *`function`*): [UnsubFunction](_promise_types_.md#unsubfunction) | `any` diff --git a/docs/api/modules/_promise_types_.md b/docs/api/modules/_promise_types_.md index e2ca30a058..47e633430d 100644 --- a/docs/api/modules/_promise_types_.md +++ b/docs/api/modules/_promise_types_.md @@ -30,7 +30,7 @@ **Ƭ DecoratedRpc$Method**: *`function`* -*Defined in [promise/types.ts:15](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/types.ts#L15)* +*Defined in [promise/types.ts:15](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/types.ts#L15)* #### Type declaration ▸(...params: *`Array`<`any`>*): `Promise`<`any`> | [UnsubFunction](_promise_types_.md#unsubfunction) @@ -50,7 +50,7 @@ ___ **Ƭ UnsubFunction**: *`function`* -*Defined in [promise/types.ts:13](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/promise/types.ts#L13)* +*Defined in [promise/types.ts:13](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/promise/types.ts#L13)* #### Type declaration ▸(): `void` diff --git a/docs/api/modules/_types_.md b/docs/api/modules/_types_.md index 8ee4bd2f46..45b9ca5b3e 100644 --- a/docs/api/modules/_types_.md +++ b/docs/api/modules/_types_.md @@ -22,7 +22,7 @@ **Ƭ ApiInterface$Events**: *`RpcRxInterface$Events` | "ready"* -*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L10)* ___ @@ -31,7 +31,7 @@ ___ **Ƭ SubmittableSendResult**: *`object`* -*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/types.ts#L38)* +*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/types.ts#L38)* #### Type declaration diff --git a/docs/api/modules/_util_filterevents_.md b/docs/api/modules/_util_filterevents_.md index 01eb7a7e7a..25087d4983 100644 --- a/docs/api/modules/_util_filterevents_.md +++ b/docs/api/modules/_util_filterevents_.md @@ -8,7 +8,7 @@ ▸ **filterEvents**(extHash: *`Hash`*, __namedParameters: *`object`*, allEvents: *`Array`<`EventRecord`>*): `Array`<`EventRecord`> | `undefined` -*Defined in [util/filterEvents.ts:9](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/api/src/util/filterEvents.ts#L9)* +*Defined in [util/filterEvents.ts:9](https://github.com/polkadot-js/api/blob/132a8dd/packages/api/src/util/filterEvents.ts#L9)* **Parameters:** diff --git a/docs/examples/promise/01_simple_connect/index.html b/docs/examples/promise/01_simple_connect/index.html index b8ce11d1ad..80f5fc7f8a 100644 --- a/docs/examples/promise/01_simple_connect/index.html +++ b/docs/examples/promise/01_simple_connect/index.html @@ -2054,7 +2054,7 @@
diff --git a/docs/examples/promise/02_listen_to_blocks/index.html b/docs/examples/promise/02_listen_to_blocks/index.html index 4fa7dbbc8b..cafdf1f349 100644 --- a/docs/examples/promise/02_listen_to_blocks/index.html +++ b/docs/examples/promise/02_listen_to_blocks/index.html @@ -2056,7 +2056,7 @@
diff --git a/docs/examples/promise/03_listen_to_balance_change/index.html b/docs/examples/promise/03_listen_to_balance_change/index.html index 9e456fc079..4247d15246 100644 --- a/docs/examples/promise/03_listen_to_balance_change/index.html +++ b/docs/examples/promise/03_listen_to_balance_change/index.html @@ -2067,7 +2067,7 @@
diff --git a/docs/examples/promise/05_read_storage/index.html b/docs/examples/promise/05_read_storage/index.html index 97bdd3bf4f..4dde5cc679 100644 --- a/docs/examples/promise/05_read_storage/index.html +++ b/docs/examples/promise/05_read_storage/index.html @@ -2066,7 +2066,7 @@
diff --git a/docs/examples/promise/07_transfer_dots/index.html b/docs/examples/promise/07_transfer_dots/index.html index f3ab7ba84e..428c5e8d44 100644 --- a/docs/examples/promise/07_transfer_dots/index.html +++ b/docs/examples/promise/07_transfer_dots/index.html @@ -2068,7 +2068,7 @@
diff --git a/docs/examples/promise/08_system_events/index.html b/docs/examples/promise/08_system_events/index.html index 3115ef2281..1210bf23e7 100644 --- a/docs/examples/promise/08_system_events/index.html +++ b/docs/examples/promise/08_system_events/index.html @@ -2065,7 +2065,7 @@
diff --git a/docs/examples/promise/09_transfer_events/index.html b/docs/examples/promise/09_transfer_events/index.html index 1a711f303e..0fcb41d4dd 100644 --- a/docs/examples/promise/09_transfer_events/index.html +++ b/docs/examples/promise/09_transfer_events/index.html @@ -2084,7 +2084,7 @@
diff --git a/docs/examples/promise/10_upgrade_chain/index.html b/docs/examples/promise/10_upgrade_chain/index.html index 78a99ef2fc..8912e09ce5 100644 --- a/docs/examples/promise/10_upgrade_chain/index.html +++ b/docs/examples/promise/10_upgrade_chain/index.html @@ -2095,7 +2095,7 @@
diff --git a/docs/examples/promise/index.html b/docs/examples/promise/index.html index af86c5d87e..5c5f1c4525 100644 --- a/docs/examples/promise/index.html +++ b/docs/examples/promise/index.html @@ -2044,7 +2044,7 @@
diff --git a/docs/index.html b/docs/index.html index 4bea4e75db..f091a2eea6 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2037,7 +2037,7 @@
diff --git a/docs/rpc-core/classes/_index_.rpc.md b/docs/rpc-core/classes/_index_.rpc.md index f36a4c738f..f40aa92b4e 100644 --- a/docs/rpc-core/classes/_index_.rpc.md +++ b/docs/rpc-core/classes/_index_.rpc.md @@ -38,7 +38,7 @@ const api = new Api(provider); ⊕ **new Rpc**(provider?: *`ProviderInterface`*): [Rpc](_index_.rpc.md) -*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-core/src/index.ts#L46)* +*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-core/src/index.ts#L46)* *__constructor__*: Default constructor for the Api Object @@ -60,7 +60,7 @@ ___ **● _provider**: *`ProviderInterface`* -*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-core/src/index.ts#L42)* +*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-core/src/index.ts#L42)* ___ @@ -71,7 +71,7 @@ ___ *Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[author](../interfaces/_types_.rpcinterface.md#author)* -*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-core/src/index.ts#L43)* +*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-core/src/index.ts#L43)* ___ @@ -82,7 +82,7 @@ ___ *Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[chain](../interfaces/_types_.rpcinterface.md#chain)* -*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-core/src/index.ts#L44)* +*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-core/src/index.ts#L44)* ___ @@ -93,7 +93,7 @@ ___ *Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[state](../interfaces/_types_.rpcinterface.md#state)* -*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-core/src/index.ts#L45)* +*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-core/src/index.ts#L45)* ___ @@ -104,7 +104,7 @@ ___ *Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[system](../interfaces/_types_.rpcinterface.md#system)* -*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-core/src/index.ts#L46)* +*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-core/src/index.ts#L46)* ___ @@ -116,7 +116,7 @@ ___ ▸ **signature**(__namedParameters: *`object`*): `string` -*Defined in [index.ts:79](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-core/src/index.ts#L79)* +*Defined in [index.ts:79](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-core/src/index.ts#L79)* *__name__*: signature diff --git a/docs/rpc-core/interfaces/_types_.rpcinterface.md b/docs/rpc-core/interfaces/_types_.rpcinterface.md index 972d69b7b9..37e823691d 100644 --- a/docs/rpc-core/interfaces/_types_.rpcinterface.md +++ b/docs/rpc-core/interfaces/_types_.rpcinterface.md @@ -16,7 +16,7 @@ **● author**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)* -*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-core/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-core/src/types.ts#L17)* ___ @@ -25,7 +25,7 @@ ___ **● chain**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)* -*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-core/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-core/src/types.ts#L18)* ___ @@ -34,7 +34,7 @@ ___ **● state**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)* -*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-core/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-core/src/types.ts#L19)* ___ @@ -43,7 +43,7 @@ ___ **● system**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)* -*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-core/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-core/src/types.ts#L20)* ___ diff --git a/docs/rpc-core/interfaces/_types_.rpcinterface_method.md b/docs/rpc-core/interfaces/_types_.rpcinterface_method.md index 399669a184..00a374026f 100644 --- a/docs/rpc-core/interfaces/_types_.rpcinterface_method.md +++ b/docs/rpc-core/interfaces/_types_.rpcinterface_method.md @@ -7,7 +7,7 @@ # Callable ▸ **__call**(...params: *`Array`<`any`>*): `Promise`<`any`> -*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-core/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-core/src/types.ts#L5)* **Parameters:** @@ -25,7 +25,7 @@ **● subscription**: *`string`* -*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-core/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-core/src/types.ts#L8)* ___ @@ -34,7 +34,7 @@ ___ **● unsubscribe**: *`function`* -*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-core/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-core/src/types.ts#L9)* #### Type declaration ▸(id: *`number`*): `Promise`<`any`> diff --git a/docs/rpc-core/modules/_types_.md b/docs/rpc-core/modules/_types_.md index 3600fbd771..c02cab4e20 100644 --- a/docs/rpc-core/modules/_types_.md +++ b/docs/rpc-core/modules/_types_.md @@ -21,7 +21,7 @@ **Ƭ RpcInterface$Section**: *`object`* -*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-core/src/types.ts#L12)* +*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-core/src/types.ts#L12)* #### Type declaration diff --git a/docs/rpc-provider/classes/_coder_index_.rpccoder.md b/docs/rpc-provider/classes/_coder_index_.rpccoder.md index b7a7266bc4..5609f39762 100644 --- a/docs/rpc-provider/classes/_coder_index_.rpccoder.md +++ b/docs/rpc-provider/classes/_coder_index_.rpccoder.md @@ -12,7 +12,7 @@ ▸ **decodeResponse**(response: *[JsonRpcResponse](../modules/_types_.md#jsonrpcresponse)*): `any` -*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/coder/index.ts#L12)* +*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/coder/index.ts#L12)* **Parameters:** @@ -29,7 +29,7 @@ ___ ▸ **encodeJson**(method: *`string`*, params: *`any` | `Array`<`any`>*): `string` -*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/coder/index.ts#L33)* +*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/coder/index.ts#L33)* **Parameters:** @@ -47,7 +47,7 @@ ___ ▸ **encodeObject**(method: *`string`*, params: *`any` | `Array`<`any`>*): [JsonRpcRequest](../modules/_types_.md#jsonrpcrequest) -*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/coder/index.ts#L39)* +*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/coder/index.ts#L39)* **Parameters:** @@ -65,7 +65,7 @@ ___ ▸ **getId**(): `number` -*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/coder/index.ts#L48)* +*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/coder/index.ts#L48)* **Returns:** `number` diff --git a/docs/rpc-provider/classes/_http_index_.httpprovider.html b/docs/rpc-provider/classes/_http_index_.httpprovider.html index 1c3b47e806..749f63b0dd 100644 --- a/docs/rpc-provider/classes/_http_index_.httpprovider.html +++ b/docs/rpc-provider/classes/_http_index_.httpprovider.html @@ -2007,7 +2007,7 @@

constructor

⊕ new HttpProvider(endpoint?: string): HttpProvider

-

Defined in http/index.ts:40

+

Defined in http/index.ts:40

Parameters:

@@ -2033,7 +2033,7 @@

hasSubscriptions

gethasSubscriptions(): boolean

-

Defined in http/index.ts:55

+

Defined in http/index.ts:55

summary: true when this provider supports subscriptions

Returns: boolean


@@ -2042,7 +2042,7 @@

isConnected

▸ isConnected(): boolean

Implementation of ProviderInterface.isConnected

-

Defined in http/index.ts:63

+

Defined in http/index.ts:63

summary: Whether the node is connected or not.

Returns: boolean true if connected

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

on

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

Implementation of ProviderInterface.on

-

Defined in http/index.ts:71

+

Defined in http/index.ts:71

summary: Events are not supported with the HttpProvider, see WsProvider.

description: HTTP Provider does not have 'on' emitters. WebSockets should be used instead.

Parameters:

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

send

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

Implementation of ProviderInterface.send

-

Defined in http/index.ts:78

+

Defined in http/index.ts:78

summary: Send HTTP POST Request with Body to configured HTTP Endpoint.

Parameters:

@@ -2106,7 +2106,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:100

+

Defined in http/index.ts:100

summary: Subscriptions are not supported with the HttpProvider, see WsProvider.

Parameters:

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

unsubscribe

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

Implementation of ProviderInterface.unsubscribe

-

Defined in http/index.ts:109

+

Defined in http/index.ts:109

summary: Subscriptions are not supported with the HttpProvider, see WsProvider.

Parameters:

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

diff --git a/docs/rpc-provider/classes/_http_index_.httpprovider.md b/docs/rpc-provider/classes/_http_index_.httpprovider.md index 823d378475..17eb64bb0c 100644 --- a/docs/rpc-provider/classes/_http_index_.httpprovider.md +++ b/docs/rpc-provider/classes/_http_index_.httpprovider.md @@ -34,7 +34,7 @@ const api = new Api(provider); ⊕ **new HttpProvider**(endpoint?: *`string`*): [HttpProvider](_http_index_.httpprovider.md) -*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/http/index.ts#L40)* +*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/http/index.ts#L40)* **Parameters:** @@ -54,7 +54,7 @@ ___ gethasSubscriptions(): `boolean` -*Defined in [http/index.ts:55](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/http/index.ts#L55)* +*Defined in [http/index.ts:55](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/http/index.ts#L55)* *__summary__*: `true` when this provider supports subscriptions @@ -72,7 +72,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)* -*Defined in [http/index.ts:63](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/http/index.ts#L63)* +*Defined in [http/index.ts:63](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/http/index.ts#L63)* *__summary__*: Whether the node is connected or not. @@ -88,7 +88,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)* -*Defined in [http/index.ts:71](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/http/index.ts#L71)* +*Defined in [http/index.ts:71](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/http/index.ts#L71)* *__summary__*: Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). @@ -112,7 +112,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)* -*Defined in [http/index.ts:78](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/http/index.ts#L78)* +*Defined in [http/index.ts:78](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/http/index.ts#L78)* *__summary__*: Send HTTP POST Request with Body to configured HTTP Endpoint. @@ -134,7 +134,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[subscribe](../interfaces/_types_.providerinterface.md#subscribe)* -*Defined in [http/index.ts:100](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/http/index.ts#L100)* +*Defined in [http/index.ts:100](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/http/index.ts#L100)* *__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). @@ -158,7 +158,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)* -*Defined in [http/index.ts:109](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/http/index.ts#L109)* +*Defined in [http/index.ts:109](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/http/index.ts#L109)* *__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). diff --git a/docs/rpc-provider/classes/_mock_index_.mock.md b/docs/rpc-provider/classes/_mock_index_.mock.md index a8ac22f756..d0b77e918e 100644 --- a/docs/rpc-provider/classes/_mock_index_.mock.md +++ b/docs/rpc-provider/classes/_mock_index_.mock.md @@ -19,7 +19,7 @@ A mock provider mainly used for testing. ⊕ **new Mock**(): [Mock](_mock_index_.mock.md) -*Defined in [mock/index.ts:68](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/mock/index.ts#L68)* +*Defined in [mock/index.ts:68](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/mock/index.ts#L68)* **Returns:** [Mock](_mock_index_.mock.md) @@ -33,7 +33,7 @@ ___ **● isUpdating**: *`boolean`* = true -*Defined in [mock/index.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/mock/index.ts#L43)* +*Defined in [mock/index.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/mock/index.ts#L43)* ___ @@ -49,7 +49,7 @@ ___ return subs; }, ({} as MockState$Subscriptions)) -*Defined in [mock/index.ts:57](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/mock/index.ts#L57)* +*Defined in [mock/index.ts:57](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/mock/index.ts#L57)* ___ @@ -61,7 +61,7 @@ ___ gethasSubscriptions(): `boolean` -*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/mock/index.ts#L74)* +*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/mock/index.ts#L74)* **Returns:** `boolean` @@ -77,7 +77,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)* -*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/mock/index.ts#L78)* +*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/mock/index.ts#L78)* **Returns:** `boolean` @@ -90,7 +90,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)* -*Defined in [mock/index.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/mock/index.ts#L82)* +*Defined in [mock/index.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/mock/index.ts#L82)* **Parameters:** @@ -110,7 +110,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)* -*Defined in [mock/index.ts:86](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/mock/index.ts#L86)* +*Defined in [mock/index.ts:86](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/mock/index.ts#L86)* **Parameters:** @@ -128,7 +128,7 @@ ___ ▸ **subscribe**(type: *`string`*, method: *`string`*, ...params: *`Array`<`any`>*): `Promise`<`number`> -*Defined in [mock/index.ts:94](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/mock/index.ts#L94)* +*Defined in [mock/index.ts:94](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/mock/index.ts#L94)* **Parameters:** @@ -149,7 +149,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)* -*Defined in [mock/index.ts:114](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/mock/index.ts#L114)* +*Defined in [mock/index.ts:114](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/mock/index.ts#L114)* **Parameters:** diff --git a/docs/rpc-provider/classes/_ws_index_.wsprovider.html b/docs/rpc-provider/classes/_ws_index_.wsprovider.html index 9ae5f6b470..757c99a42c 100644 --- a/docs/rpc-provider/classes/_ws_index_.wsprovider.html +++ b/docs/rpc-provider/classes/_ws_index_.wsprovider.html @@ -2007,7 +2007,7 @@

constructor

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

-

Defined in ws/index.ts:75

+

Defined in ws/index.ts:75

Parameters:

@@ -2039,7 +2039,7 @@

hasSubscriptions

gethasSubscriptions(): boolean

-

Defined in ws/index.ts:101

+

Defined in ws/index.ts:101

summary: true when this provider supports subscriptions

Returns: boolean


@@ -2047,7 +2047,7 @@

connect

▸ connect(): void

-

Defined in ws/index.ts:110

+

Defined in ws/index.ts:110

summary: Manually connect

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

Returns: void

@@ -2055,7 +2055,7 @@

isConnected

▸ isConnected(): boolean

-

Defined in ws/index.ts:127

+

Defined in ws/index.ts:127

summary: Whether the node is connected or not.

Returns: boolean true if connected

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

on

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

-

Defined in ws/index.ts:136

+

Defined in ws/index.ts:136

summary: Listens on events after having subscribed using the subscribe function.

Parameters:

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

send

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

-

Defined in ws/index.ts:146

+

Defined in ws/index.ts:146

summary: Send JSON data using WebSockets to configured HTTP Endpoint or queue.

Parameters:

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

subscribe

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

-

Defined in ws/index.ts:200

+

Defined in ws/index.ts:200

name: subscribe

summary: Allows subscribing to a specific event.

example:

@@ -2177,7 +2177,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:209

+

Defined in ws/index.ts:209

summary: Allows unsubscribing to subscriptions made with subscribe.

Parameters:

@@ -2247,7 +2247,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]] diff --git a/docs/rpc-provider/classes/_ws_index_.wsprovider.md b/docs/rpc-provider/classes/_ws_index_.wsprovider.md index bbed9fa95d..01ac147944 100644 --- a/docs/rpc-provider/classes/_ws_index_.wsprovider.md +++ b/docs/rpc-provider/classes/_ws_index_.wsprovider.md @@ -34,7 +34,7 @@ const api = new Api(provider); ⊕ **new WsProvider**(endpoint?: *`string`*, autoConnect?: *`boolean`*): [WsProvider](_ws_index_.wsprovider.md) -*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/ws/index.ts#L75)* +*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/ws/index.ts#L75)* **Parameters:** @@ -55,7 +55,7 @@ ___ gethasSubscriptions(): `boolean` -*Defined in [ws/index.ts:101](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/ws/index.ts#L101)* +*Defined in [ws/index.ts:101](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/ws/index.ts#L101)* *__summary__*: `true` when this provider supports subscriptions @@ -71,7 +71,7 @@ ___ ▸ **connect**(): `void` -*Defined in [ws/index.ts:110](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/ws/index.ts#L110)* +*Defined in [ws/index.ts:110](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/ws/index.ts#L110)* *__summary__*: Manually connect @@ -86,7 +86,7 @@ ___ ▸ **isConnected**(): `boolean` -*Defined in [ws/index.ts:127](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/ws/index.ts#L127)* +*Defined in [ws/index.ts:127](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/ws/index.ts#L127)* *__summary__*: Whether the node is connected or not. @@ -100,7 +100,7 @@ ___ ▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void` -*Defined in [ws/index.ts:136](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/ws/index.ts#L136)* +*Defined in [ws/index.ts:136](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/ws/index.ts#L136)* *__summary__*: Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function. @@ -120,7 +120,7 @@ ___ ▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`> -*Defined in [ws/index.ts:146](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/ws/index.ts#L146)* +*Defined in [ws/index.ts:146](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/ws/index.ts#L146)* *__summary__*: Send JSON data using WebSockets to configured HTTP Endpoint or queue. @@ -141,7 +141,7 @@ ___ ▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`> -*Defined in [ws/index.ts:200](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/ws/index.ts#L200)* +*Defined in [ws/index.ts:200](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/ws/index.ts#L200)* *__name__*: subscribe @@ -179,7 +179,7 @@ ___ ▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> -*Defined in [ws/index.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/ws/index.ts#L209)* +*Defined in [ws/index.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/ws/index.ts#L209)* *__summary__*: Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe). diff --git a/docs/rpc-provider/index.html b/docs/rpc-provider/index.html index 7713489d58..3bac39a687 100644 --- a/docs/rpc-provider/index.html +++ b/docs/rpc-provider/index.html @@ -2055,7 +2055,7 @@ diff --git a/docs/rpc-provider/interfaces/_types_.providerinterface.md b/docs/rpc-provider/interfaces/_types_.providerinterface.md index 154d68612a..613cb7facc 100644 --- a/docs/rpc-provider/interfaces/_types_.providerinterface.md +++ b/docs/rpc-provider/interfaces/_types_.providerinterface.md @@ -17,7 +17,7 @@ **● hasSubscriptions**: *`boolean`* -*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/types.ts#L45)* +*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/types.ts#L45)* ___ @@ -29,7 +29,7 @@ ___ ▸ **isConnected**(): `boolean` -*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/types.ts#L46)* +*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/types.ts#L46)* **Returns:** `boolean` @@ -40,7 +40,7 @@ ___ ▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void` -*Defined in [types.ts:47](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/types.ts#L47)* +*Defined in [types.ts:47](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/types.ts#L47)* **Parameters:** @@ -58,7 +58,7 @@ ___ ▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`> -*Defined in [types.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/types.ts#L48)* +*Defined in [types.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/types.ts#L48)* **Parameters:** @@ -76,7 +76,7 @@ ___ ▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`> -*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/types.ts#L49)* +*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/types.ts#L49)* **Parameters:** @@ -96,7 +96,7 @@ ___ ▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> -*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/types.ts#L50)* +*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/types.ts#L50)* **Parameters:** diff --git a/docs/rpc-provider/modules/_http_types_.md b/docs/rpc-provider/modules/_http_types_.md index 1318c8b2de..630ce03171 100644 --- a/docs/rpc-provider/modules/_http_types_.md +++ b/docs/rpc-provider/modules/_http_types_.md @@ -8,7 +8,7 @@ **Ƭ HttpState**: *`object`* -*Defined in [http/types.ts:9](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/http/types.ts#L9)* +*Defined in [http/types.ts:9](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/http/types.ts#L9)* #### Type declaration diff --git a/docs/rpc-provider/modules/_mock_types_.md b/docs/rpc-provider/modules/_mock_types_.md index 1322739132..cdee606bd9 100644 --- a/docs/rpc-provider/modules/_mock_types_.md +++ b/docs/rpc-provider/modules/_mock_types_.md @@ -8,7 +8,7 @@ **Ƭ MockState$Db**: *`object`* -*Defined in [mock/types.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/mock/types.ts#L16)* +*Defined in [mock/types.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/mock/types.ts#L16)* #### Type declaration @@ -21,7 +21,7 @@ ___ **Ƭ MockState$Requests**: *`object`* -*Defined in [mock/types.ts:20](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/mock/types.ts#L20)* +*Defined in [mock/types.ts:20](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/mock/types.ts#L20)* #### Type declaration @@ -45,7 +45,7 @@ ___ **Ƭ MockState$Subscription$Callback**: *`function`* -*Defined in [mock/types.ts:5](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/mock/types.ts#L5)* +*Defined in [mock/types.ts:5](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/mock/types.ts#L5)* #### Type declaration ▸(error: *`Error` | `null`*, value: *`any`*): `void` @@ -66,7 +66,7 @@ ___ **Ƭ MockState$Subscriptions**: *`object`* -*Defined in [mock/types.ts:7](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/mock/types.ts#L7)* +*Defined in [mock/types.ts:7](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/mock/types.ts#L7)* #### Type declaration diff --git a/docs/rpc-provider/modules/_types_.md b/docs/rpc-provider/modules/_types_.md index 448e2d08ad..77b243c847 100644 --- a/docs/rpc-provider/modules/_types_.md +++ b/docs/rpc-provider/modules/_types_.md @@ -27,7 +27,7 @@ **Ƭ JsonRpcObject**: *`object`* -*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/types.ts#L5)* #### Type declaration @@ -38,7 +38,7 @@ ___ **Ƭ JsonRpcRequest**: *[JsonRpcObject](_types_.md#jsonrpcobject) & `object`* -*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/types.ts#L10)* ___ @@ -47,7 +47,7 @@ ___ **Ƭ JsonRpcResponse**: *[JsonRpcObject](_types_.md#jsonrpcobject) & [JsonRpcResponseBase](_types_.md#jsonrpcresponsebase)* -*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/types.ts#L36)* +*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/types.ts#L36)* ___ @@ -56,7 +56,7 @@ ___ **Ƭ JsonRpcResponseBase**: *`JsonRpcResponse$Single` & `JsonRpcResponse$Subscription`* -*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/types.ts#L34)* +*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/types.ts#L34)* ___ @@ -65,7 +65,7 @@ ___ **Ƭ JsonRpcResponseBase$Error**: *`object`* -*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/types.ts#L15)* #### Type declaration @@ -76,7 +76,7 @@ ___ **Ƭ ProviderInterface$Callback**: *`function`* -*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/types.ts#L38)* +*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/types.ts#L38)* #### Type declaration ▸(result: *`any`*): `void` @@ -96,7 +96,7 @@ ___ **Ƭ ProviderInterface$EmitCb**: *`function`* -*Defined in [types.ts:42](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/types.ts#L42)* +*Defined in [types.ts:42](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/types.ts#L42)* #### Type declaration ▸(value?: *`any`*): `any` @@ -116,7 +116,7 @@ ___ **Ƭ ProviderInterface$Emitted**: *"connected" | "disconnected" | "error"* -*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-provider/src/types.ts#L40)* +*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-provider/src/types.ts#L40)* ___ diff --git a/docs/rpc-rx/classes/_index_.rpcrx.md b/docs/rpc-rx/classes/_index_.rpcrx.md index 0099dbc9c0..77aa58e7e5 100644 --- a/docs/rpc-rx/classes/_index_.rpcrx.md +++ b/docs/rpc-rx/classes/_index_.rpcrx.md @@ -32,7 +32,7 @@ const api = new RpcRx(provider); ⊕ **new RpcRx**(providerOrRpc?: *`Rpc` | `ProviderInterface`*): [RpcRx](_index_.rpcrx.md) -*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-rx/src/index.ts#L45)* +*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-rx/src/index.ts#L45)* **Parameters:** @@ -52,7 +52,7 @@ ___ **● author**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)* -*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-rx/src/index.ts#L42)* +*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-rx/src/index.ts#L42)* ___ @@ -61,7 +61,7 @@ ___ **● chain**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)* -*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-rx/src/index.ts#L43)* +*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-rx/src/index.ts#L43)* ___ @@ -70,7 +70,7 @@ ___ **● state**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)* -*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-rx/src/index.ts#L44)* +*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-rx/src/index.ts#L44)* ___ @@ -79,7 +79,7 @@ ___ **● system**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)* -*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-rx/src/index.ts#L45)* +*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-rx/src/index.ts#L45)* ___ @@ -91,7 +91,7 @@ ___ ▸ **isConnected**(): `BehaviorSubject`<`boolean`> -*Defined in [index.ts:66](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-rx/src/index.ts#L66)* +*Defined in [index.ts:66](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-rx/src/index.ts#L66)* **Returns:** `BehaviorSubject`<`boolean`> @@ -102,7 +102,7 @@ ___ ▸ **on**(type: *[RpcRxInterface$Events](../modules/_types_.md#rpcrxinterface_events)*, handler: *`function`*): `void` -*Defined in [index.ts:70](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-rx/src/index.ts#L70)* +*Defined in [index.ts:70](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-rx/src/index.ts#L70)* **Parameters:** diff --git a/docs/rpc-rx/modules/_types_.md b/docs/rpc-rx/modules/_types_.md index f1933e69c2..5f5cc11c5d 100644 --- a/docs/rpc-rx/modules/_types_.md +++ b/docs/rpc-rx/modules/_types_.md @@ -8,7 +8,7 @@ **Ƭ RpcRxInterface**: *`object`* -*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-rx/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-rx/src/types.ts#L16)* #### Type declaration @@ -19,7 +19,7 @@ ___ **Ƭ RpcRxInterface$Events**: *`ProviderInterface$Emitted`* -*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-rx/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-rx/src/types.ts#L14)* ___ @@ -28,7 +28,7 @@ ___ **Ƭ RpcRxInterface$Method**: *`function`* -*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-rx/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-rx/src/types.ts#L8)* #### Type declaration ▸(...params: *`Array`<`any`>*): `Observable`<`any`> | `ReplaySubject`<`any`> @@ -48,7 +48,7 @@ ___ **Ƭ RpcRxInterface$Section**: *`object`* -*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/rpc-rx/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/132a8dd/packages/rpc-rx/src/types.ts#L10)* #### Type declaration diff --git a/docs/type-extrinsics/modules/_frommetadata_.md b/docs/type-extrinsics/modules/_frommetadata_.md index 7b8fec533f..10f2a2d310 100644 --- a/docs/type-extrinsics/modules/_frommetadata_.md +++ b/docs/type-extrinsics/modules/_frommetadata_.md @@ -8,7 +8,7 @@ ▸ **fromMetadata**(metadata: *`Metadata`*): `ModulesWithMethods` -*Defined in [fromMetadata.ts:21](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/type-extrinsics/src/fromMetadata.ts#L21)* +*Defined in [fromMetadata.ts:21](https://github.com/polkadot-js/api/blob/132a8dd/packages/type-extrinsics/src/fromMetadata.ts#L21)* Extend a storage object with the storage modules & module functions present in the metadata. diff --git a/docs/type-extrinsics/modules/_utils_createunchecked_.md b/docs/type-extrinsics/modules/_utils_createunchecked_.md index 1cd933d830..1806350a1d 100644 --- a/docs/type-extrinsics/modules/_utils_createunchecked_.md +++ b/docs/type-extrinsics/modules/_utils_createunchecked_.md @@ -8,7 +8,7 @@ ▸ **createDescriptor**(section: *`string`*, method: *`string`*, index: *`number`*, meta: *`FunctionMetadata`*): `MethodFunction` -*Defined in [utils/createUnchecked.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/type-extrinsics/src/utils/createUnchecked.ts#L16)* +*Defined in [utils/createUnchecked.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/type-extrinsics/src/utils/createUnchecked.ts#L16)* From the metadata of a function in the module's storage, generate the function that will return the an UncheckExtrinsic. diff --git a/docs/type-jsonrpc/modules/_create_method_.md b/docs/type-jsonrpc/modules/_create_method_.md index b6ec17a8b8..863c008d1b 100644 --- a/docs/type-jsonrpc/modules/_create_method_.md +++ b/docs/type-jsonrpc/modules/_create_method_.md @@ -8,7 +8,7 @@ ▸ **createMethod**(section: *`string`*, method: *`string`*, __namedParameters: *`object`*): [RpcMethod](_types_.md#rpcmethod) -*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/type-jsonrpc/src/create/method.ts#L9)* +*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/132a8dd/packages/type-jsonrpc/src/create/method.ts#L9)* **Parameters:** diff --git a/docs/type-jsonrpc/modules/_create_param_.md b/docs/type-jsonrpc/modules/_create_param_.md index fe05d44443..ea288fca01 100644 --- a/docs/type-jsonrpc/modules/_create_param_.md +++ b/docs/type-jsonrpc/modules/_create_param_.md @@ -8,7 +8,7 @@ ▸ **createParam**(name: *`string`*, type: *`CodecTypes`*, __namedParameters?: *`object`*): [RpcParam](_types_.md#rpcparam) -*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/type-jsonrpc/src/create/param.ts#L12)* +*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/132a8dd/packages/type-jsonrpc/src/create/param.ts#L12)* **Parameters:** diff --git a/docs/type-jsonrpc/modules/_types_.md b/docs/type-jsonrpc/modules/_types_.md index 24d2012e83..79d69f40ef 100644 --- a/docs/type-jsonrpc/modules/_types_.md +++ b/docs/type-jsonrpc/modules/_types_.md @@ -8,7 +8,7 @@ **Ƭ RpcMethod**: *`object`* -*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/type-jsonrpc/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/132a8dd/packages/type-jsonrpc/src/types.ts#L24)* #### Type declaration @@ -19,7 +19,7 @@ ___ **Ƭ RpcMethodOpt**: *`object`* -*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/type-jsonrpc/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/132a8dd/packages/type-jsonrpc/src/types.ts#L13)* #### Type declaration @@ -30,7 +30,7 @@ ___ **Ƭ RpcParam**: *`object`* -*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/type-jsonrpc/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/132a8dd/packages/type-jsonrpc/src/types.ts#L7)* #### Type declaration @@ -41,7 +41,7 @@ ___ **Ƭ RpcSection**: *`object`* -*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/type-jsonrpc/src/types.ts#L38)* +*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/132a8dd/packages/type-jsonrpc/src/types.ts#L38)* #### Type declaration diff --git a/docs/type-storage/interfaces/_types_.storage.md b/docs/type-storage/interfaces/_types_.storage.md index 063e953e83..7752555d25 100644 --- a/docs/type-storage/interfaces/_types_.storage.md +++ b/docs/type-storage/interfaces/_types_.storage.md @@ -15,7 +15,7 @@ **● substrate**: *`object`* -*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/type-storage/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/132a8dd/packages/type-storage/src/types.ts#L17)* #### Type declaration diff --git a/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md b/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md index 3bf5aa886d..2757cd4ed1 100644 --- a/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md +++ b/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md @@ -12,7 +12,7 @@ **● isUnhashed**: *`undefined` | `false` | `true`* -*Defined in [utils/createFunction.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/type-storage/src/utils/createFunction.ts#L14)* +*Defined in [utils/createFunction.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/type-storage/src/utils/createFunction.ts#L14)* ___ @@ -21,7 +21,7 @@ ___ **● key**: *`undefined` | `string`* -*Defined in [utils/createFunction.ts:15](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/type-storage/src/utils/createFunction.ts#L15)* +*Defined in [utils/createFunction.ts:15](https://github.com/polkadot-js/api/blob/132a8dd/packages/type-storage/src/utils/createFunction.ts#L15)* ___ diff --git a/docs/type-storage/modules/_frommetadata_.md b/docs/type-storage/modules/_frommetadata_.md index 36197f18d9..e72880044f 100644 --- a/docs/type-storage/modules/_frommetadata_.md +++ b/docs/type-storage/modules/_frommetadata_.md @@ -8,7 +8,7 @@ ▸ **fromMetadata**(metadata: *`Metadata`*): [Storage](../interfaces/_types_.storage.md) -*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/type-storage/src/fromMetadata.ts#L20)* +*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/132a8dd/packages/type-storage/src/fromMetadata.ts#L20)* Extend a storage object with the storage modules & module functions present in the metadata. diff --git a/docs/type-storage/modules/_storage_.md b/docs/type-storage/modules/_storage_.md index b739e26343..261efafd0a 100644 --- a/docs/type-storage/modules/_storage_.md +++ b/docs/type-storage/modules/_storage_.md @@ -8,7 +8,7 @@ **storage**: *`object`* -*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/type-storage/src/storage.ts#L8)* +*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/132a8dd/packages/type-storage/src/storage.ts#L8)* @@ -16,7 +16,7 @@ **● substrate**: *["substrate"](_substrate_.md)* -*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/type-storage/src/storage.ts#L9)* +*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/132a8dd/packages/type-storage/src/storage.ts#L9)* ___ diff --git a/docs/type-storage/modules/_substrate_.md b/docs/type-storage/modules/_substrate_.md index d495680441..88efd200fd 100644 --- a/docs/type-storage/modules/_substrate_.md +++ b/docs/type-storage/modules/_substrate_.md @@ -11,7 +11,7 @@ type: 'u32' }) -*Defined in [substrate.ts:45](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/type-storage/src/substrate.ts#L45)* +*Defined in [substrate.ts:45](https://github.com/polkadot-js/api/blob/132a8dd/packages/type-storage/src/substrate.ts#L45)* ___ @@ -23,7 +23,7 @@ ___ type: 'u32' }) -*Defined in [substrate.ts:50](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/type-storage/src/substrate.ts#L50)* +*Defined in [substrate.ts:50](https://github.com/polkadot-js/api/blob/132a8dd/packages/type-storage/src/substrate.ts#L50)* ___ @@ -35,7 +35,7 @@ ___ type: 'u32' }) -*Defined in [substrate.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/type-storage/src/substrate.ts#L60)* +*Defined in [substrate.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/type-storage/src/substrate.ts#L60)* ___ @@ -47,7 +47,7 @@ ___ type: 'Bytes' }) -*Defined in [substrate.ts:35](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/type-storage/src/substrate.ts#L35)* +*Defined in [substrate.ts:35](https://github.com/polkadot-js/api/blob/132a8dd/packages/type-storage/src/substrate.ts#L35)* ___ @@ -59,7 +59,7 @@ ___ type: 'u32' }) -*Defined in [substrate.ts:55](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/type-storage/src/substrate.ts#L55)* +*Defined in [substrate.ts:55](https://github.com/polkadot-js/api/blob/132a8dd/packages/type-storage/src/substrate.ts#L55)* ___ @@ -71,7 +71,7 @@ ___ type: 'u64' }) -*Defined in [substrate.ts:40](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/type-storage/src/substrate.ts#L40)* +*Defined in [substrate.ts:40](https://github.com/polkadot-js/api/blob/132a8dd/packages/type-storage/src/substrate.ts#L40)* ___ diff --git a/docs/type-storage/modules/_utils_createfunction_.md b/docs/type-storage/modules/_utils_createfunction_.md index dd2994c0ae..b4a084afea 100644 --- a/docs/type-storage/modules/_utils_createfunction_.md +++ b/docs/type-storage/modules/_utils_createfunction_.md @@ -20,7 +20,7 @@ ▸ **createFunction**(section: *`Text` | `string`*, method: *`Text` | `string`*, meta: *`StorageFunctionMetadata`*, options?: *[CreateItemOptions](../interfaces/_utils_createfunction_.createitemoptions.md)*): `StorageFunction` -*Defined in [utils/createFunction.ts:28](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/type-storage/src/utils/createFunction.ts#L28)* +*Defined in [utils/createFunction.ts:28](https://github.com/polkadot-js/api/blob/132a8dd/packages/type-storage/src/utils/createFunction.ts#L28)* From the schema of a function in the module's storage, generate the function that will return the correct storage key. diff --git a/docs/types/classes/_accountid_.accountid.html b/docs/types/classes/_accountid_.accountid.html index 662814bf2e..28bfe59381 100644 --- a/docs/types/classes/_accountid_.accountid.html +++ b/docs/types/classes/_accountid_.accountid.html @@ -2003,7 +2003,7 @@

constructor

⊕ new AccountId(value?: AnyU8a): AccountId

Overrides U8aFixed.constructor

-

Defined in AccountId.ts:19

+

Defined in AccountId.ts:19

Parameters:

@@ -2028,7 +2028,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2037,7 +2037,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2046,7 +2046,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2055,7 +2055,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2087,7 +2087,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2096,7 +2096,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Overrides U8a.toJSON

-

Defined in AccountId.ts:46

+

Defined in AccountId.ts:46

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2105,7 +2105,7 @@

▸ toString(): string

Implementation of Codec.toString

Overrides U8a.toString

-

Defined in AccountId.ts:53

+

Defined in AccountId.ts:53

description: Returns the string representation of the value

Returns: string


@@ -2113,7 +2113,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2139,7 +2139,7 @@

<Static> encode

▸ encode(value: Uint8Array): string

-

Defined in AccountId.ts:27

+

Defined in AccountId.ts:27

Parameters:

@@ -2200,7 +2200,7 @@ diff --git a/docs/types/classes/_accountid_.accountid.md b/docs/types/classes/_accountid_.accountid.md index d1086b10ce..c71ede6709 100644 --- a/docs/types/classes/_accountid_.accountid.md +++ b/docs/types/classes/_accountid_.accountid.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AccountId.ts#L19)* +*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AccountId.ts#L19)* **Parameters:** @@ -51,7 +51,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -68,7 +68,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -86,7 +86,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -103,7 +103,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -127,7 +127,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -144,7 +144,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AccountId.ts#L46)* +*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AccountId.ts#L46)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -161,7 +161,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AccountId.ts#L53)* +*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AccountId.ts#L53)* *__description__*: Returns the string representation of the value @@ -176,7 +176,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -195,7 +195,7 @@ ___ ▸ **encode**(value: *`Uint8Array`*): `string` -*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AccountId.ts#L27)* +*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AccountId.ts#L27)* **Parameters:** diff --git a/docs/types/classes/_accountindex_.accountindex.html b/docs/types/classes/_accountindex_.accountindex.html index 9fb29d2ad4..361cd173fe 100644 --- a/docs/types/classes/_accountindex_.accountindex.html +++ b/docs/types/classes/_accountindex_.accountindex.html @@ -2000,7 +2000,7 @@

constructor

⊕ new AccountIndex(value?: AnyNumber): AccountIndex

Overrides U32.constructor

-

Defined in AccountIndex.ts:29

+

Defined in AccountIndex.ts:29

Parameters:

@@ -2025,7 +2025,7 @@

toBn

▸ toBn(): BN

Overrides AbstractInt.toBn

-

Defined in AccountIndex.ts:92

+

Defined in AccountIndex.ts:92

description: Returns the BN representation of the AccountIndex

Returns: BN


@@ -2034,7 +2034,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Overrides UInt.toHex

-

Defined in AccountIndex.ts:99

+

Defined in AccountIndex.ts:99

description: Returns a hex string representation of the value

Returns: string


@@ -2043,7 +2043,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Overrides AbstractInt.toJSON

-

Defined in AccountIndex.ts:108

+

Defined in AccountIndex.ts:108

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2052,7 +2052,7 @@

▸ toString(): string

Implementation of Codec.toString

Overrides AbstractInt.toString

-

Defined in AccountIndex.ts:115

+

Defined in AccountIndex.ts:115

description: Returns the string representation of the value

Returns: string


@@ -2061,7 +2061,7 @@

▸ toU8a(isBare?: undefined | false | true, isStorageKey?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Overrides UInt.toU8a

-

Defined in AccountIndex.ts:126

+

Defined in AccountIndex.ts:126

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2094,7 +2094,7 @@

<Static> calcLength

▸ calcLength(_value: BN | number): number

-

Defined in AccountIndex.ts:52

+

Defined in AccountIndex.ts:52

Parameters:

@@ -2116,7 +2116,7 @@

<Static> decodeAccountIndex

▸ decodeAccountIndex(value: AnyNumber): BN | Uint8Array | number | string

-

Defined in AccountIndex.ts:36

+

Defined in AccountIndex.ts:36

Parameters:

@@ -2137,7 +2137,7 @@

<Static> readLength

▸ readLength(input: Uint8Array): [number, number]

-

Defined in AccountIndex.ts:66

+

Defined in AccountIndex.ts:66

Parameters:

@@ -2158,7 +2158,7 @@

<Static> writeLength

▸ writeLength(input: Uint8Array): Uint8Array

-

Defined in AccountIndex.ts:80

+

Defined in AccountIndex.ts:80

Parameters:

@@ -2219,7 +2219,7 @@ diff --git a/docs/types/classes/_accountindex_.accountindex.md b/docs/types/classes/_accountindex_.accountindex.md index 3bea03399e..a312c71f85 100644 --- a/docs/types/classes/_accountindex_.accountindex.md +++ b/docs/types/classes/_accountindex_.accountindex.md @@ -24,7 +24,7 @@ *Overrides [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)* -*Defined in [AccountIndex.ts:29](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AccountIndex.ts#L29)* +*Defined in [AccountIndex.ts:29](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AccountIndex.ts#L29)* **Parameters:** @@ -46,7 +46,7 @@ ___ *Overrides AbstractInt.toBn* -*Defined in [AccountIndex.ts:92](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AccountIndex.ts#L92)* +*Defined in [AccountIndex.ts:92](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AccountIndex.ts#L92)* *__description__*: Returns the BN representation of the AccountIndex @@ -63,7 +63,7 @@ ___ *Overrides [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [AccountIndex.ts:99](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AccountIndex.ts#L99)* +*Defined in [AccountIndex.ts:99](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AccountIndex.ts#L99)* *__description__*: Returns a hex string representation of the value @@ -80,7 +80,7 @@ ___ *Overrides AbstractInt.toJSON* -*Defined in [AccountIndex.ts:108](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AccountIndex.ts#L108)* +*Defined in [AccountIndex.ts:108](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AccountIndex.ts#L108)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -97,7 +97,7 @@ ___ *Overrides AbstractInt.toString* -*Defined in [AccountIndex.ts:115](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AccountIndex.ts#L115)* +*Defined in [AccountIndex.ts:115](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AccountIndex.ts#L115)* *__description__*: Returns the string representation of the value @@ -114,7 +114,7 @@ ___ *Overrides [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* -*Defined in [AccountIndex.ts:126](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AccountIndex.ts#L126)* +*Defined in [AccountIndex.ts:126](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AccountIndex.ts#L126)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -134,7 +134,7 @@ ___ ▸ **calcLength**(_value: *`BN` | `number`*): `number` -*Defined in [AccountIndex.ts:52](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AccountIndex.ts#L52)* +*Defined in [AccountIndex.ts:52](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AccountIndex.ts#L52)* **Parameters:** @@ -151,7 +151,7 @@ ___ ▸ **decodeAccountIndex**(value: *[AnyNumber](../modules/_types_.md#anynumber)*): `BN` | `Uint8Array` | `number` | `string` -*Defined in [AccountIndex.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AccountIndex.ts#L36)* +*Defined in [AccountIndex.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AccountIndex.ts#L36)* **Parameters:** @@ -168,7 +168,7 @@ ___ ▸ **readLength**(input: *`Uint8Array`*): [`number`, `number`] -*Defined in [AccountIndex.ts:66](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AccountIndex.ts#L66)* +*Defined in [AccountIndex.ts:66](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AccountIndex.ts#L66)* **Parameters:** @@ -185,7 +185,7 @@ ___ ▸ **writeLength**(input: *`Uint8Array`*): `Uint8Array` -*Defined in [AccountIndex.ts:80](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AccountIndex.ts#L80)* +*Defined in [AccountIndex.ts:80](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AccountIndex.ts#L80)* **Parameters:** diff --git a/docs/types/classes/_address_.address.html b/docs/types/classes/_address_.address.html index a35c73f88b..141b7f1b64 100644 --- a/docs/types/classes/_address_.address.html +++ b/docs/types/classes/_address_.address.html @@ -1996,7 +1996,7 @@

constructor

⊕ new Address(value?: AnyAddress): Address

Overrides Base.constructor

-

Defined in Address.ts:25

+

Defined in Address.ts:25

Parameters:

@@ -2020,14 +2020,14 @@

encodedLength

getencodedLength(): number

-

Defined in Address.ts:67

+

Defined in Address.ts:67

description: The length of the value when encoded as a Uint8Array

Returns: number


rawLength

getrawLength(): number

-

Defined in Address.ts:81

+

Defined in Address.ts:81

description: The length of the raw value, either AccountIndex or AccountId

Returns: number


@@ -2035,28 +2035,28 @@

toHex

▸ toHex(): string

-

Defined in Address.ts:90

+

Defined in Address.ts:90

description: Returns a hex string representation of the value

Returns: string


toJSON

▸ toJSON(): any

-

Defined in Address.ts:97

+

Defined in Address.ts:97

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


toString

▸ toString(): string

-

Defined in Address.ts:104

+

Defined in Address.ts:104

description: Returns the string representation of the value

Returns: string


toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

-

Defined in Address.ts:112

+

Defined in Address.ts:112

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2082,7 +2082,7 @@

<Static> decodeAddress

▸ decodeAddress(value: AnyAddress): AccountId | AccountIndex

-

Defined in Address.ts:32

+

Defined in Address.ts:32

Parameters:

@@ -2143,7 +2143,7 @@ diff --git a/docs/types/classes/_address_.address.md b/docs/types/classes/_address_.address.md index 66bd1a2843..5e4251fc19 100644 --- a/docs/types/classes/_address_.address.md +++ b/docs/types/classes/_address_.address.md @@ -20,7 +20,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [Address.ts:25](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Address.ts#L25)* +*Defined in [Address.ts:25](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Address.ts#L25)* **Parameters:** @@ -40,7 +40,7 @@ ___ getencodedLength(): `number` -*Defined in [Address.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Address.ts#L67)* +*Defined in [Address.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Address.ts#L67)* *__description__*: The length of the value when encoded as a Uint8Array @@ -53,7 +53,7 @@ ___ getrawLength(): `number` -*Defined in [Address.ts:81](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Address.ts#L81)* +*Defined in [Address.ts:81](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Address.ts#L81)* *__description__*: The length of the raw value, either AccountIndex or AccountId @@ -69,7 +69,7 @@ ___ ▸ **toHex**(): `string` -*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Address.ts#L90)* +*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Address.ts#L90)* *__description__*: Returns a hex string representation of the value @@ -82,7 +82,7 @@ ___ ▸ **toJSON**(): `any` -*Defined in [Address.ts:97](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Address.ts#L97)* +*Defined in [Address.ts:97](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Address.ts#L97)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -95,7 +95,7 @@ ___ ▸ **toString**(): `string` -*Defined in [Address.ts:104](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Address.ts#L104)* +*Defined in [Address.ts:104](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Address.ts#L104)* *__description__*: Returns the string representation of the value @@ -108,7 +108,7 @@ ___ ▸ **toU8a**(isBare?: *`undefined` | `false` | `true`*): `Uint8Array` -*Defined in [Address.ts:112](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Address.ts#L112)* +*Defined in [Address.ts:112](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Address.ts#L112)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -127,7 +127,7 @@ ___ ▸ **decodeAddress**(value: *`AnyAddress`*): [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) -*Defined in [Address.ts:32](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Address.ts#L32)* +*Defined in [Address.ts:32](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Address.ts#L32)* **Parameters:** diff --git a/docs/types/classes/_attestedcandidate_.attestedcandidate.md b/docs/types/classes/_attestedcandidate_.attestedcandidate.md index f85ef08be2..d32ee0fa81 100644 --- a/docs/types/classes/_attestedcandidate_.attestedcandidate.md +++ b/docs/types/classes/_attestedcandidate_.attestedcandidate.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [AttestedCandidate.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AttestedCandidate.ts#L74)* +*Defined in [AttestedCandidate.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AttestedCandidate.ts#L74)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -66,7 +66,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -86,7 +86,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -107,7 +107,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -128,7 +128,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -145,7 +145,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -162,7 +162,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -179,7 +179,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -194,7 +194,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -215,7 +215,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_attestedcandidate_.availabilityvote.md b/docs/types/classes/_attestedcandidate_.availabilityvote.md index 6f9f2f5122..202147ecc3 100644 --- a/docs/types/classes/_attestedcandidate_.availabilityvote.md +++ b/docs/types/classes/_attestedcandidate_.availabilityvote.md @@ -23,7 +23,7 @@ *Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L22)* +*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L22)* **Parameters:** @@ -46,7 +46,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -61,7 +61,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -81,7 +81,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L126)* +*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L126)* *__description__*: Filters the array with the callback @@ -105,7 +105,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L135)* +*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L135)* *__description__*: Maps the array with the callback @@ -130,7 +130,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Converts the Object to an standard JavaScript Array @@ -147,7 +147,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Returns a hex string representation of the value @@ -164,7 +164,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -183,7 +183,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L100)* +*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L100)* *__description__*: Returns the string representation of the value @@ -198,7 +198,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L109)* +*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L109)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -219,7 +219,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_attestedcandidate_.balanceupload.md b/docs/types/classes/_attestedcandidate_.balanceupload.md index 46c6c23575..3807e192a5 100644 --- a/docs/types/classes/_attestedcandidate_.balanceupload.md +++ b/docs/types/classes/_attestedcandidate_.balanceupload.md @@ -23,7 +23,7 @@ *Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L22)* +*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L22)* **Parameters:** @@ -46,7 +46,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -61,7 +61,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -81,7 +81,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L126)* +*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L126)* *__description__*: Filters the array with the callback @@ -105,7 +105,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L135)* +*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L135)* *__description__*: Maps the array with the callback @@ -130,7 +130,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Converts the Object to an standard JavaScript Array @@ -147,7 +147,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Returns a hex string representation of the value @@ -164,7 +164,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -183,7 +183,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L100)* +*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L100)* *__description__*: Returns the string representation of the value @@ -198,7 +198,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L109)* +*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L109)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -219,7 +219,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_attestedcandidate_.candidatereceipt.md b/docs/types/classes/_attestedcandidate_.candidatereceipt.md index 93fba7c77c..1d8de09b99 100644 --- a/docs/types/classes/_attestedcandidate_.candidatereceipt.md +++ b/docs/types/classes/_attestedcandidate_.candidatereceipt.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [AttestedCandidate.ts:30](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AttestedCandidate.ts#L30)* +*Defined in [AttestedCandidate.ts:30](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AttestedCandidate.ts#L30)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -62,7 +62,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -82,7 +82,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -103,7 +103,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -124,7 +124,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -141,7 +141,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -158,7 +158,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -175,7 +175,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -190,7 +190,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -211,7 +211,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_attestedcandidate_.candidatesignature.md b/docs/types/classes/_attestedcandidate_.candidatesignature.md index d8768eaaba..c0523b9102 100644 --- a/docs/types/classes/_attestedcandidate_.candidatesignature.md +++ b/docs/types/classes/_attestedcandidate_.candidatesignature.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/H512.ts#L14)* +*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/H512.ts#L14)* **Parameters:** @@ -51,7 +51,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -68,7 +68,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -86,7 +86,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -103,7 +103,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -127,7 +127,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -144,7 +144,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -163,7 +163,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -178,7 +178,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_attestedcandidate_.egressqueueroot.md b/docs/types/classes/_attestedcandidate_.egressqueueroot.md index 03248febbb..49ef0801d3 100644 --- a/docs/types/classes/_attestedcandidate_.egressqueueroot.md +++ b/docs/types/classes/_attestedcandidate_.egressqueueroot.md @@ -23,7 +23,7 @@ *Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L22)* +*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L22)* **Parameters:** @@ -46,7 +46,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -61,7 +61,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -81,7 +81,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L126)* +*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L126)* *__description__*: Filters the array with the callback @@ -105,7 +105,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L135)* +*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L135)* *__description__*: Maps the array with the callback @@ -130,7 +130,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Converts the Object to an standard JavaScript Array @@ -147,7 +147,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Returns a hex string representation of the value @@ -164,7 +164,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -183,7 +183,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L100)* +*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L100)* *__description__*: Returns the string representation of the value @@ -198,7 +198,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L109)* +*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L109)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -219,7 +219,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_attestedcandidate_.explicitcandidatesignature.md b/docs/types/classes/_attestedcandidate_.explicitcandidatesignature.md index a47fab8e93..c3f0623f38 100644 --- a/docs/types/classes/_attestedcandidate_.explicitcandidatesignature.md +++ b/docs/types/classes/_attestedcandidate_.explicitcandidatesignature.md @@ -25,7 +25,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/H512.ts#L14)* +*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/H512.ts#L14)* **Parameters:** @@ -47,7 +47,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -64,7 +64,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -82,7 +82,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -99,7 +99,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -123,7 +123,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -140,7 +140,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -159,7 +159,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -174,7 +174,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_attestedcandidate_.headdata.md b/docs/types/classes/_attestedcandidate_.headdata.md index 731e9eff98..72b3e12b71 100644 --- a/docs/types/classes/_attestedcandidate_.headdata.md +++ b/docs/types/classes/_attestedcandidate_.headdata.md @@ -25,7 +25,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bytes.ts#L18)* +*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bytes.ts#L18)* **Parameters:** @@ -49,7 +49,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bytes.ts#L64)* +*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bytes.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -86,7 +86,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -110,7 +110,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -127,7 +127,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -146,7 +146,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -163,7 +163,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bytes.ts#L72)* +*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bytes.ts#L72)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_attestedcandidate_.implicitcandidatesignature.md b/docs/types/classes/_attestedcandidate_.implicitcandidatesignature.md index 6b4fb15856..521e65560e 100644 --- a/docs/types/classes/_attestedcandidate_.implicitcandidatesignature.md +++ b/docs/types/classes/_attestedcandidate_.implicitcandidatesignature.md @@ -25,7 +25,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/H512.ts#L14)* +*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/H512.ts#L14)* **Parameters:** @@ -47,7 +47,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -64,7 +64,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -82,7 +82,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -99,7 +99,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -123,7 +123,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -140,7 +140,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -159,7 +159,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -174,7 +174,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_attestedcandidate_.validityattestation.md b/docs/types/classes/_attestedcandidate_.validityattestation.md index 6a9f1fc7b6..89de0f45ca 100644 --- a/docs/types/classes/_attestedcandidate_.validityattestation.md +++ b/docs/types/classes/_attestedcandidate_.validityattestation.md @@ -20,7 +20,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [AttestedCandidate.ts:54](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AttestedCandidate.ts#L54)* +*Defined in [AttestedCandidate.ts:54](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AttestedCandidate.ts#L54)* **Parameters:** @@ -42,7 +42,7 @@ getencodedLength(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* -*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L97)* +*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L97)* *__description__*: The length of the value when encoded as a Uint8Array @@ -57,7 +57,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L104)* +*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L104)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type @@ -72,7 +72,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L111)* +*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L111)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone) @@ -87,7 +87,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L118)* +*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L118)* *__description__*: The name of the type this enum value represents @@ -102,7 +102,7 @@ getvalue(): [Codec](../interfaces/_types_.codec.md) *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L125)* +*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L125)* *__description__*: The value of the enum @@ -122,7 +122,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L132)* +*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L132)* *__description__*: Returns a hex string representation of the value @@ -139,7 +139,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L139)* +*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L139)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -154,7 +154,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L146)* +*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L146)* *__description__*: Returns the number representation for the value @@ -171,7 +171,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [codec/EnumType.ts:153](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L153)* +*Defined in [codec/EnumType.ts:153](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L153)* *__description__*: Returns the string representation of the value @@ -186,7 +186,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L161)* +*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L161)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_attestedcandidate_.validityvote.md b/docs/types/classes/_attestedcandidate_.validityvote.md index 24641432f2..316ab9b3c7 100644 --- a/docs/types/classes/_attestedcandidate_.validityvote.md +++ b/docs/types/classes/_attestedcandidate_.validityvote.md @@ -23,7 +23,7 @@ *Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L22)* +*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L22)* **Parameters:** @@ -46,7 +46,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -61,7 +61,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -81,7 +81,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L126)* +*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L126)* *__description__*: Filters the array with the callback @@ -105,7 +105,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L135)* +*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L135)* *__description__*: Maps the array with the callback @@ -130,7 +130,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Converts the Object to an standard JavaScript Array @@ -147,7 +147,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Returns a hex string representation of the value @@ -164,7 +164,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -183,7 +183,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L100)* +*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L100)* *__description__*: Returns the string representation of the value @@ -198,7 +198,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L109)* +*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L109)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -219,7 +219,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_authorityid_.authorityid.html b/docs/types/classes/_authorityid_.authorityid.html index 1c56a7a4e1..1a3807ca34 100644 --- a/docs/types/classes/_authorityid_.authorityid.html +++ b/docs/types/classes/_authorityid_.authorityid.html @@ -2002,7 +2002,7 @@

⊕ new AuthorityId(value?: AnyU8a): AuthorityId

Inherited from AccountId.constructor

Overrides U8aFixed.constructor

-

Defined in AccountId.ts:19

+

Defined in AccountId.ts:19

Parameters:

@@ -2027,7 +2027,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2036,7 +2036,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2045,7 +2045,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2054,7 +2054,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2086,7 +2086,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2096,7 +2096,7 @@

Implementation of Codec.toJSON

Inherited from AccountId.toJSON

Overrides U8a.toJSON

-

Defined in AccountId.ts:46

+

Defined in AccountId.ts:46

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2106,7 +2106,7 @@

Implementation of Codec.toString

Inherited from AccountId.toString

Overrides U8a.toString

-

Defined in AccountId.ts:53

+

Defined in AccountId.ts:53

description: Returns the string representation of the value

Returns: string


@@ -2114,7 +2114,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2141,7 +2141,7 @@

<Static> encode

▸ encode(value: Uint8Array): string

Inherited from AccountId.encode

-

Defined in AccountId.ts:27

+

Defined in AccountId.ts:27

Parameters:

@@ -2202,7 +2202,7 @@ diff --git a/docs/types/classes/_authorityid_.authorityid.md b/docs/types/classes/_authorityid_.authorityid.md index ee36877e36..62179caddc 100644 --- a/docs/types/classes/_authorityid_.authorityid.md +++ b/docs/types/classes/_authorityid_.authorityid.md @@ -27,7 +27,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AccountId.ts#L19)* +*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AccountId.ts#L19)* **Parameters:** @@ -49,7 +49,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -84,7 +84,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -101,7 +101,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -125,7 +125,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -144,7 +144,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AccountId.ts#L46)* +*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AccountId.ts#L46)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -163,7 +163,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AccountId.ts#L53)* +*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AccountId.ts#L53)* *__description__*: Returns the string representation of the value @@ -178,7 +178,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -199,7 +199,7 @@ ___ *Inherited from [AccountId](_accountid_.accountid.md).[encode](_accountid_.accountid.md#encode)* -*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AccountId.ts#L27)* +*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AccountId.ts#L27)* **Parameters:** diff --git a/docs/types/classes/_balance_.balance.html b/docs/types/classes/_balance_.balance.html index 0bc56b638e..c4209e1f90 100644 --- a/docs/types/classes/_balance_.balance.html +++ b/docs/types/classes/_balance_.balance.html @@ -2001,7 +2001,7 @@

⊕ new Balance(value?: AnyNumber): Balance

Inherited from U128.constructor

Overrides UInt.constructor

-

Defined in U128.ts:14

+

Defined in U128.ts:14

Parameters:

@@ -2026,7 +2026,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2035,7 +2035,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2101,7 +2101,7 @@ diff --git a/docs/types/classes/_balance_.balance.md b/docs/types/classes/_balance_.balance.md index 9f5b4c78e2..38d8461e27 100644 --- a/docs/types/classes/_balance_.balance.md +++ b/docs/types/classes/_balance_.balance.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/U128.ts#L14)* +*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/U128.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -69,7 +69,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_bft_.bftauthoritysignature.html b/docs/types/classes/_bft_.bftauthoritysignature.html index df676c4017..2780244da6 100644 --- a/docs/types/classes/_bft_.bftauthoritysignature.html +++ b/docs/types/classes/_bft_.bftauthoritysignature.html @@ -2002,7 +2002,7 @@

constructor

⊕ new BftAuthoritySignature(value?: BftAuthoritySignatureValue | Uint8Array): BftAuthoritySignature

Overrides Tuple.constructor

-

Defined in Bft.ts:20

+

Defined in Bft.ts:20

Parameters:

@@ -2026,14 +2026,14 @@

Types

getTypes(): Array<string>

Inherited from Tuple.Types

-

Defined in codec/Tuple.ts:68

+

Defined in codec/Tuple.ts:68

description: The types definition of the tuple

Returns: Array<string>


authorityId

getauthorityId(): AuthorityId

-

Defined in Bft.ts:31

+

Defined in Bft.ts:31

description: The wrapped [[AuthoriyId]]

Returns: AuthorityId


@@ -2041,14 +2041,14 @@

encodedLength

getencodedLength(): number

Inherited from Tuple.encodedLength

-

Defined in codec/Tuple.ts:59

+

Defined in codec/Tuple.ts:59

description: The length of the value when encoded as a Uint8Array

Returns: number


signature

getsignature(): Signature

-

Defined in Bft.ts:38

+

Defined in Bft.ts:38

description: The wrapped Signature value

Returns: Signature


@@ -2058,7 +2058,7 @@

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Inherited from Tuple.filter

Overrides Array.filter

-

Defined in codec/Tuple.ts:126

+

Defined in codec/Tuple.ts:126

description: Filters the array with the callback

Parameters:

@@ -2089,7 +2089,7 @@

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Tuple.map

Overrides Array.map

-

Defined in codec/Tuple.ts:135

+

Defined in codec/Tuple.ts:135

description: Maps the array with the callback

Type parameters:

U

@@ -2121,7 +2121,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

-

Defined in codec/Tuple.ts:77

+

Defined in codec/Tuple.ts:77

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2130,7 +2130,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

-

Defined in codec/Tuple.ts:84

+

Defined in codec/Tuple.ts:84

description: Returns a hex string representation of the value

Returns: string


@@ -2139,7 +2139,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

-

Defined in codec/Tuple.ts:91

+

Defined in codec/Tuple.ts:91

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2149,7 +2149,7 @@

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:100

+

Defined in codec/Tuple.ts:100

description: Returns the string representation of the value

Returns: string


@@ -2157,7 +2157,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Tuple.toU8a

-

Defined in codec/Tuple.ts:109

+

Defined in codec/Tuple.ts:109

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2184,7 +2184,7 @@

<Static> with

▸ with(Types: TupleConstructors): Constructor<Tuple>

Inherited from Tuple.with

-

Defined in codec/Tuple.ts:48

+

Defined in codec/Tuple.ts:48

Parameters:

@@ -2245,7 +2245,7 @@ diff --git a/docs/types/classes/_bft_.bftauthoritysignature.md b/docs/types/classes/_bft_.bftauthoritysignature.md index a81f8286b9..dd4020378a 100644 --- a/docs/types/classes/_bft_.bftauthoritysignature.md +++ b/docs/types/classes/_bft_.bftauthoritysignature.md @@ -27,7 +27,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [Bft.ts:20](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bft.ts#L20)* +*Defined in [Bft.ts:20](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bft.ts#L20)* **Parameters:** @@ -49,7 +49,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -62,7 +62,7 @@ ___ getauthorityId(): [AuthorityId](_authorityid_.authorityid.md) -*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bft.ts#L31)* +*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bft.ts#L31)* *__description__*: The wrapped \[\[AuthoriyId\]\] @@ -77,7 +77,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -90,7 +90,7 @@ ___ getsignature(): [Signature](_signature_.signature.md) -*Defined in [Bft.ts:38](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bft.ts#L38)* +*Defined in [Bft.ts:38](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bft.ts#L38)* *__description__*: The wrapped [Signature](_signature_.signature.md) value @@ -110,7 +110,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L126)* +*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L126)* *__description__*: Filters the array with the callback @@ -134,7 +134,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L135)* +*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L135)* *__description__*: Maps the array with the callback @@ -159,7 +159,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Converts the Object to an standard JavaScript Array @@ -176,7 +176,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Returns a hex string representation of the value @@ -193,7 +193,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -212,7 +212,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L100)* +*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L100)* *__description__*: Returns the string representation of the value @@ -227,7 +227,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L109)* +*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L109)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -248,7 +248,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_bft_.bfthashsignature.html b/docs/types/classes/_bft_.bfthashsignature.html index f0b683d5f7..3aeadcd96d 100644 --- a/docs/types/classes/_bft_.bfthashsignature.html +++ b/docs/types/classes/_bft_.bfthashsignature.html @@ -2002,7 +2002,7 @@

constructor

⊕ new BftHashSignature(value?: BftHashSignatureValue | Uint8Array): BftHashSignature

Overrides Tuple.constructor

-

Defined in Bft.ts:51

+

Defined in Bft.ts:51

Parameters:

@@ -2026,7 +2026,7 @@

Types

getTypes(): Array<string>

Inherited from Tuple.Types

-

Defined in codec/Tuple.ts:68

+

Defined in codec/Tuple.ts:68

description: The types definition of the tuple

Returns: Array<string>


@@ -2034,21 +2034,21 @@

encodedLength

getencodedLength(): number

Inherited from Tuple.encodedLength

-

Defined in codec/Tuple.ts:59

+

Defined in codec/Tuple.ts:59

description: The length of the value when encoded as a Uint8Array

Returns: number


hash

gethash(): Hash

-

Defined in Bft.ts:62

+

Defined in Bft.ts:62

description: The wrapped Hash

Returns: Hash


signature

getsignature(): Signature

-

Defined in Bft.ts:69

+

Defined in Bft.ts:69

description: The wrapped Signature

Returns: Signature


@@ -2058,7 +2058,7 @@

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Inherited from Tuple.filter

Overrides Array.filter

-

Defined in codec/Tuple.ts:126

+

Defined in codec/Tuple.ts:126

description: Filters the array with the callback

Parameters:

@@ -2089,7 +2089,7 @@

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Tuple.map

Overrides Array.map

-

Defined in codec/Tuple.ts:135

+

Defined in codec/Tuple.ts:135

description: Maps the array with the callback

Type parameters:

U

@@ -2121,7 +2121,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

-

Defined in codec/Tuple.ts:77

+

Defined in codec/Tuple.ts:77

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2130,7 +2130,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

-

Defined in codec/Tuple.ts:84

+

Defined in codec/Tuple.ts:84

description: Returns a hex string representation of the value

Returns: string


@@ -2139,7 +2139,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

-

Defined in codec/Tuple.ts:91

+

Defined in codec/Tuple.ts:91

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2149,7 +2149,7 @@

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:100

+

Defined in codec/Tuple.ts:100

description: Returns the string representation of the value

Returns: string


@@ -2157,7 +2157,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Tuple.toU8a

-

Defined in codec/Tuple.ts:109

+

Defined in codec/Tuple.ts:109

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2184,7 +2184,7 @@

<Static> with

▸ with(Types: TupleConstructors): Constructor<Tuple>

Inherited from Tuple.with

-

Defined in codec/Tuple.ts:48

+

Defined in codec/Tuple.ts:48

Parameters:

@@ -2245,7 +2245,7 @@ diff --git a/docs/types/classes/_bft_.bfthashsignature.md b/docs/types/classes/_bft_.bfthashsignature.md index dc3c0fcc45..c86b8b8eb1 100644 --- a/docs/types/classes/_bft_.bfthashsignature.md +++ b/docs/types/classes/_bft_.bfthashsignature.md @@ -27,7 +27,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [Bft.ts:51](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bft.ts#L51)* +*Defined in [Bft.ts:51](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bft.ts#L51)* **Parameters:** @@ -49,7 +49,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -64,7 +64,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -77,7 +77,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Bft.ts:62](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bft.ts#L62)* +*Defined in [Bft.ts:62](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bft.ts#L62)* *__description__*: The wrapped [Hash](_hash_.hash.md) @@ -90,7 +90,7 @@ ___ getsignature(): [Signature](_signature_.signature.md) -*Defined in [Bft.ts:69](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bft.ts#L69)* +*Defined in [Bft.ts:69](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bft.ts#L69)* *__description__*: The wrapped [Signature](_signature_.signature.md) @@ -110,7 +110,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L126)* +*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L126)* *__description__*: Filters the array with the callback @@ -134,7 +134,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L135)* +*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L135)* *__description__*: Maps the array with the callback @@ -159,7 +159,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Converts the Object to an standard JavaScript Array @@ -176,7 +176,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Returns a hex string representation of the value @@ -193,7 +193,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -212,7 +212,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L100)* +*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L100)* *__description__*: Returns the string representation of the value @@ -227,7 +227,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L109)* +*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L109)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -248,7 +248,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_block_.block.html b/docs/types/classes/_block_.block.html index f68ab599d0..c603ba4bd6 100644 --- a/docs/types/classes/_block_.block.html +++ b/docs/types/classes/_block_.block.html @@ -2005,7 +2005,7 @@

constructor

⊕ new Block(value?: BlockValue | Uint8Array): Block

Overrides Struct.constructor

-

Defined in Block.ts:24

+

Defined in Block.ts:24

Parameters:

@@ -2029,14 +2029,14 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


contentHash

getcontentHash(): Hash

-

Defined in Block.ts:35

+

Defined in Block.ts:35

description: Encodes a content Hash for the block

Returns: Hash


@@ -2044,28 +2044,28 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


extrinsics

getextrinsics(): Extrinsics

-

Defined in Block.ts:44

+

Defined in Block.ts:44

description: The Extrinsics contained in the block

Returns: Extrinsics


hash

gethash(): Hash

-

Defined in Block.ts:51

+

Defined in Block.ts:51

description: Block/header Hash

Returns: Hash


getheader(): Header

-

Defined in Block.ts:58

+

Defined in Block.ts:58

description: The Header of the block

Returns: Header


@@ -2075,7 +2075,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2100,7 +2100,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2123,7 +2123,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2132,7 +2132,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2141,7 +2141,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2150,7 +2150,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2158,7 +2158,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2185,7 +2185,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2248,7 +2248,7 @@ diff --git a/docs/types/classes/_block_.block.md b/docs/types/classes/_block_.block.md index f18bdf6381..e878c9f90b 100644 --- a/docs/types/classes/_block_.block.md +++ b/docs/types/classes/_block_.block.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Block.ts:24](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Block.ts#L24)* +*Defined in [Block.ts:24](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Block.ts#L24)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -64,7 +64,7 @@ ___ getcontentHash(): [Hash](_hash_.hash.md) -*Defined in [Block.ts:35](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Block.ts#L35)* +*Defined in [Block.ts:35](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Block.ts#L35)* *__description__*: Encodes a content [Hash](_hash_.hash.md) for the block @@ -79,7 +79,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -92,7 +92,7 @@ ___ getextrinsics(): [Extrinsics](_extrinsics_.extrinsics.md) -*Defined in [Block.ts:44](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Block.ts#L44)* +*Defined in [Block.ts:44](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Block.ts#L44)* *__description__*: The [Extrinsics](_extrinsics_.extrinsics.md) contained in the block @@ -105,7 +105,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Block.ts:51](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Block.ts#L51)* +*Defined in [Block.ts:51](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Block.ts#L51)* *__description__*: Block/header [Hash](_hash_.hash.md) @@ -118,7 +118,7 @@ ___ getheader(): [Header](_header_.header.md) -*Defined in [Block.ts:58](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Block.ts#L58)* +*Defined in [Block.ts:58](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Block.ts#L58)* *__description__*: The [Header](_header_.header.md) of the block @@ -138,7 +138,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -159,7 +159,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -180,7 +180,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -197,7 +197,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -214,7 +214,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -231,7 +231,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -246,7 +246,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -267,7 +267,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_blocknumber_.blocknumber.html b/docs/types/classes/_blocknumber_.blocknumber.html index dbb79bf2fd..0fde89f35b 100644 --- a/docs/types/classes/_blocknumber_.blocknumber.html +++ b/docs/types/classes/_blocknumber_.blocknumber.html @@ -2001,7 +2001,7 @@

⊕ new BlockNumber(value?: AnyNumber): BlockNumber

Inherited from U64.constructor

Overrides UInt.constructor

-

Defined in U64.ts:14

+

Defined in U64.ts:14

Parameters:

@@ -2026,7 +2026,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2035,7 +2035,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2101,7 +2101,7 @@ diff --git a/docs/types/classes/_blocknumber_.blocknumber.md b/docs/types/classes/_blocknumber_.blocknumber.md index e24401b00e..8dc1863e55 100644 --- a/docs/types/classes/_blocknumber_.blocknumber.md +++ b/docs/types/classes/_blocknumber_.blocknumber.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/U64.ts#L14)* +*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/U64.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -69,7 +69,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_bool_.bool.html b/docs/types/classes/_bool_.bool.html index 5788d3d353..879ea2ac96 100644 --- a/docs/types/classes/_bool_.bool.html +++ b/docs/types/classes/_bool_.bool.html @@ -1999,7 +1999,7 @@

constructor

⊕ new Bool(value?: Bool | Boolean | Uint8Array | boolean | number): Bool

-

Defined in Bool.ts:15

+

Defined in Bool.ts:15

Parameters:

@@ -2033,7 +2033,7 @@

encodedLength

getencodedLength(): number

-

Defined in Bool.ts:35

+

Defined in Bool.ts:35

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2042,7 +2042,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in Bool.ts:42

+

Defined in Bool.ts:42

description: Returns a hex string representation of the value

Returns: string


@@ -2050,7 +2050,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in Bool.ts:49

+

Defined in Bool.ts:49

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2058,14 +2058,14 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in Bool.ts:56

+

Defined in Bool.ts:56

description: Returns the string representation of the value

Returns: string


toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

-

Defined in Bool.ts:64

+

Defined in Bool.ts:64

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2131,7 +2131,7 @@ diff --git a/docs/types/classes/_bool_.bool.md b/docs/types/classes/_bool_.bool.md index f1cbf4c2da..1792f50c02 100644 --- a/docs/types/classes/_bool_.bool.md +++ b/docs/types/classes/_bool_.bool.md @@ -22,7 +22,7 @@ ⊕ **new Bool**(value?: *[Bool](_bool_.bool.md) | `Boolean` | `Uint8Array` | `boolean` | `number`*): [Bool](_bool_.bool.md) -*Defined in [Bool.ts:15](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bool.ts#L15)* +*Defined in [Bool.ts:15](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bool.ts#L15)* **Parameters:** @@ -54,7 +54,7 @@ ___ getencodedLength(): `number` -*Defined in [Bool.ts:35](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bool.ts#L35)* +*Defined in [Bool.ts:35](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bool.ts#L35)* *__description__*: The length of the value when encoded as a Uint8Array @@ -72,7 +72,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [Bool.ts:42](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bool.ts#L42)* +*Defined in [Bool.ts:42](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bool.ts#L42)* *__description__*: Returns a hex string representation of the value @@ -87,7 +87,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [Bool.ts:49](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bool.ts#L49)* +*Defined in [Bool.ts:49](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bool.ts#L49)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -102,7 +102,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [Bool.ts:56](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bool.ts#L56)* +*Defined in [Bool.ts:56](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bool.ts#L56)* *__description__*: Returns the string representation of the value @@ -115,7 +115,7 @@ ___ ▸ **toU8a**(isBare?: *`undefined` | `false` | `true`*): `Uint8Array` -*Defined in [Bool.ts:64](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bool.ts#L64)* +*Defined in [Bool.ts:64](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bool.ts#L64)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_bytes_.bytes.html b/docs/types/classes/_bytes_.bytes.html index 13716601d2..bf3a04e481 100644 --- a/docs/types/classes/_bytes_.bytes.html +++ b/docs/types/classes/_bytes_.bytes.html @@ -2007,7 +2007,7 @@

constructor

⊕ new Bytes(value?: AnyU8a): Bytes

Overrides U8a.constructor

-

Defined in Bytes.ts:18

+

Defined in Bytes.ts:18

Parameters:

@@ -2030,7 +2030,7 @@

encodedLength

getencodedLength(): number

Overrides U8a.encodedLength

-

Defined in Bytes.ts:64

+

Defined in Bytes.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2039,7 +2039,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2049,7 +2049,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2081,7 +2081,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2090,7 +2090,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2100,7 +2100,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2108,7 +2108,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Overrides U8a.toU8a

-

Defined in Bytes.ts:72

+

Defined in Bytes.ts:72

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2174,7 +2174,7 @@ diff --git a/docs/types/classes/_bytes_.bytes.md b/docs/types/classes/_bytes_.bytes.md index 8c2236d592..2ef85a1807 100644 --- a/docs/types/classes/_bytes_.bytes.md +++ b/docs/types/classes/_bytes_.bytes.md @@ -37,7 +37,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bytes.ts#L18)* +*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bytes.ts#L18)* **Parameters:** @@ -59,7 +59,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bytes.ts#L64)* +*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bytes.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -76,7 +76,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -96,7 +96,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -120,7 +120,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -137,7 +137,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -156,7 +156,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -171,7 +171,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bytes.ts#L72)* +*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bytes.ts#L72)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_chainproperties_.chainproperties.html b/docs/types/classes/_chainproperties_.chainproperties.html index 255c65e485..8a681a8169 100644 --- a/docs/types/classes/_chainproperties_.chainproperties.html +++ b/docs/types/classes/_chainproperties_.chainproperties.html @@ -1999,7 +1999,7 @@

constructor

⊕ new ChainProperties(value?: object | null): ChainProperties

-

Defined in ChainProperties.ts:17

+

Defined in ChainProperties.ts:17

Parameters:

@@ -2028,7 +2028,7 @@

encodedLength

getencodedLength(): number

-

Defined in ChainProperties.ts:29

+

Defined in ChainProperties.ts:29

description: Always 0, never encodes as a Uint8Array

Returns: number


@@ -2037,7 +2037,7 @@

get

▸ get(name: string): any | undefined

Overrides Map.get

-

Defined in ChainProperties.ts:37

+

Defined in ChainProperties.ts:37

description: Returns a specific names entry in the structure

Parameters:

@@ -2062,7 +2062,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in ChainProperties.ts:44

+

Defined in ChainProperties.ts:44

description: Unimplemented, will throw

Returns: string


@@ -2070,7 +2070,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in ChainProperties.ts:51

+

Defined in ChainProperties.ts:51

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2078,14 +2078,14 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in ChainProperties.ts:62

+

Defined in ChainProperties.ts:62

description: Returns the string representation of the value

Returns: string


toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

-

Defined in ChainProperties.ts:69

+

Defined in ChainProperties.ts:69

description: Unimplemented, will throw

Parameters:

@@ -2149,7 +2149,7 @@ diff --git a/docs/types/classes/_chainproperties_.chainproperties.md b/docs/types/classes/_chainproperties_.chainproperties.md index 7923dae406..8edadeb180 100644 --- a/docs/types/classes/_chainproperties_.chainproperties.md +++ b/docs/types/classes/_chainproperties_.chainproperties.md @@ -22,7 +22,7 @@ ⊕ **new ChainProperties**(value?: *`object` | `null`*): [ChainProperties](_chainproperties_.chainproperties.md) -*Defined in [ChainProperties.ts:17](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ChainProperties.ts#L17)* +*Defined in [ChainProperties.ts:17](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ChainProperties.ts#L17)* **Parameters:** @@ -54,7 +54,7 @@ ___ getencodedLength(): `number` -*Defined in [ChainProperties.ts:29](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ChainProperties.ts#L29)* +*Defined in [ChainProperties.ts:29](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ChainProperties.ts#L29)* *__description__*: Always 0, never encodes as a Uint8Array @@ -72,7 +72,7 @@ ___ *Overrides Map.get* -*Defined in [ChainProperties.ts:37](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ChainProperties.ts#L37)* +*Defined in [ChainProperties.ts:37](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ChainProperties.ts#L37)* *__description__*: Returns a specific names entry in the structure @@ -93,7 +93,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [ChainProperties.ts:44](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ChainProperties.ts#L44)* +*Defined in [ChainProperties.ts:44](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ChainProperties.ts#L44)* *__description__*: Unimplemented, will throw @@ -108,7 +108,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [ChainProperties.ts:51](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ChainProperties.ts#L51)* +*Defined in [ChainProperties.ts:51](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ChainProperties.ts#L51)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -123,7 +123,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [ChainProperties.ts:62](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ChainProperties.ts#L62)* +*Defined in [ChainProperties.ts:62](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ChainProperties.ts#L62)* *__description__*: Returns the string representation of the value @@ -136,7 +136,7 @@ ___ ▸ **toU8a**(isBare?: *`undefined` | `false` | `true`*): `Uint8Array` -*Defined in [ChainProperties.ts:69](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ChainProperties.ts#L69)* +*Defined in [ChainProperties.ts:69](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ChainProperties.ts#L69)* *__description__*: Unimplemented, will throw diff --git a/docs/types/classes/_codec_base_.base.html b/docs/types/classes/_codec_base_.base.html index 51c268ca8f..9ed6f405ab 100644 --- a/docs/types/classes/_codec_base_.base.html +++ b/docs/types/classes/_codec_base_.base.html @@ -2002,7 +2002,7 @@

constructor

⊕ new Base(value?: any): Base

-

Defined in codec/Base.ts:10

+

Defined in codec/Base.ts:10

Parameters:

@@ -2063,7 +2063,7 @@ diff --git a/docs/types/classes/_codec_base_.base.md b/docs/types/classes/_codec_base_.base.md index 1c5f8571ba..4b7618fcd2 100644 --- a/docs/types/classes/_codec_base_.base.md +++ b/docs/types/classes/_codec_base_.base.md @@ -30,7 +30,7 @@ ⊕ **new Base**(value?: *`any`*): [Base](_codec_base_.base.md) -*Defined in [codec/Base.ts:10](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Base.ts#L10)* +*Defined in [codec/Base.ts:10](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Base.ts#L10)* **Parameters:** diff --git a/docs/types/classes/_codec_compact_.compact.html b/docs/types/classes/_codec_compact_.compact.html index 08ea1eb151..2db5432c65 100644 --- a/docs/types/classes/_codec_compact_.compact.html +++ b/docs/types/classes/_codec_compact_.compact.html @@ -2001,7 +2001,7 @@

constructor

⊕ new Compact(Type: Constructor<UInt | Moment>, value?: Compact | AnyNumber): Compact

Overrides Base.constructor

-

Defined in codec/Compact.ts:23

+

Defined in codec/Compact.ts:23

Parameters:

@@ -2032,25 +2032,25 @@

<Static> addLengthPrefix

● addLengthPrefix: compactAddLength = compactAddLength

-

Defined in codec/Compact.ts:41

+

Defined in codec/Compact.ts:41

Prepend a Uint8Array with its compact length. param: The Uint8Array to be prefixed


<Static> decodeU8a

● decodeU8a: compactFromU8a = compactFromU8a

-

Defined in codec/Compact.ts:42

+

Defined in codec/Compact.ts:42


<Static> encodeU8a

● encodeU8a: compactToU8a = compactToU8a

-

Defined in codec/Compact.ts:43

+

Defined in codec/Compact.ts:43


Accessors

encodedLength

getencodedLength(): number

-

Defined in codec/Compact.ts:72

+

Defined in codec/Compact.ts:72

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2058,14 +2058,14 @@

bitLength

▸ bitLength(): UIntBitLength

-

Defined in codec/Compact.ts:79

+

Defined in codec/Compact.ts:79

description: Returns the number of bits in the value

Returns: UIntBitLength


toBn

▸ toBn(): BN

-

Defined in codec/Compact.ts:86

+

Defined in codec/Compact.ts:86

description: Returns the BN representation of the number

Returns: BN


@@ -2073,7 +2073,7 @@

toHex

▸ toHex(): any

Implementation of Codec.toHex

-

Defined in codec/Compact.ts:93

+

Defined in codec/Compact.ts:93

description: Returns a hex string representation of the value

Returns: any


@@ -2081,14 +2081,14 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Compact.ts:100

+

Defined in codec/Compact.ts:100

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


toNumber

▸ toNumber(): number

-

Defined in codec/Compact.ts:107

+

Defined in codec/Compact.ts:107

description: Returns the number representation for the value

Returns: number


@@ -2096,14 +2096,14 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/Compact.ts:114

+

Defined in codec/Compact.ts:114

description: Returns the string representation of the value

Returns: string


toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

-

Defined in codec/Compact.ts:122

+

Defined in codec/Compact.ts:122

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2129,7 +2129,7 @@

<Static> decodeCompact

▸ decodeCompact(Type: Constructor<UInt | Moment>, value: Compact | AnyNumber): Moment | UInt

-

Defined in codec/Compact.ts:51

+

Defined in codec/Compact.ts:51

Parameters:

@@ -2156,7 +2156,7 @@

<Static> stripLengthPrefix

▸ stripLengthPrefix(u8a: Uint8Array, bitLength?: UIntBitLength): Uint8Array

-

Defined in codec/Compact.ts:45

+

Defined in codec/Compact.ts:45

Parameters:

@@ -2184,7 +2184,7 @@

<Static> with

▸ with(Type: Constructor<UInt | Moment>): Constructor<Compact>

-

Defined in codec/Compact.ts:28

+

Defined in codec/Compact.ts:28

Parameters:

@@ -2246,7 +2246,7 @@ diff --git a/docs/types/classes/_codec_compact_.compact.md b/docs/types/classes/_codec_compact_.compact.md index e3edfc2b71..b626fdd363 100644 --- a/docs/types/classes/_codec_compact_.compact.md +++ b/docs/types/classes/_codec_compact_.compact.md @@ -26,7 +26,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Compact.ts:23](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L23)* +*Defined in [codec/Compact.ts:23](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L23)* **Parameters:** @@ -47,7 +47,7 @@ ___ **● addLengthPrefix**: *`compactAddLength`* = compactAddLength -*Defined in [codec/Compact.ts:41](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L41)* +*Defined in [codec/Compact.ts:41](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L41)* Prepend a Uint8Array with its compact length. *__param__*: The Uint8Array to be prefixed @@ -59,7 +59,7 @@ ___ **● decodeU8a**: *`compactFromU8a`* = compactFromU8a -*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L42)* +*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L42)* ___ @@ -68,7 +68,7 @@ ___ **● encodeU8a**: *`compactToU8a`* = compactToU8a -*Defined in [codec/Compact.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L43)* +*Defined in [codec/Compact.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L43)* ___ @@ -80,7 +80,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Compact.ts:72](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L72)* +*Defined in [codec/Compact.ts:72](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L72)* *__description__*: The length of the value when encoded as a Uint8Array @@ -96,7 +96,7 @@ ___ ▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) -*Defined in [codec/Compact.ts:79](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L79)* +*Defined in [codec/Compact.ts:79](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L79)* *__description__*: Returns the number of bits in the value @@ -109,7 +109,7 @@ ___ ▸ **toBn**(): `BN` -*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L86)* +*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L86)* *__description__*: Returns the BN representation of the number @@ -124,7 +124,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Compact.ts:93](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L93)* +*Defined in [codec/Compact.ts:93](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L93)* *__description__*: Returns a hex string representation of the value @@ -139,7 +139,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Compact.ts:100](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L100)* +*Defined in [codec/Compact.ts:100](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L100)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -152,7 +152,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [codec/Compact.ts:107](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L107)* +*Defined in [codec/Compact.ts:107](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L107)* *__description__*: Returns the number representation for the value @@ -167,7 +167,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [codec/Compact.ts:114](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L114)* +*Defined in [codec/Compact.ts:114](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L114)* *__description__*: Returns the string representation of the value @@ -180,7 +180,7 @@ ___ ▸ **toU8a**(isBare?: *`undefined` | `false` | `true`*): `Uint8Array` -*Defined in [codec/Compact.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L122)* +*Defined in [codec/Compact.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L122)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -199,7 +199,7 @@ ___ ▸ **decodeCompact**(Type: *[Constructor](../modules/_types_.md#constructor)<[UInt](_codec_uint_.uint.md) | [Moment](_moment_.moment.md)>*, value: *[Compact](_codec_compact_.compact.md) | [AnyNumber](../modules/_types_.md#anynumber)*): [Moment](_moment_.moment.md) | [UInt](_codec_uint_.uint.md) -*Defined in [codec/Compact.ts:51](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L51)* +*Defined in [codec/Compact.ts:51](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L51)* **Parameters:** @@ -217,7 +217,7 @@ ___ ▸ **stripLengthPrefix**(u8a: *`Uint8Array`*, bitLength?: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*): `Uint8Array` -*Defined in [codec/Compact.ts:45](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L45)* +*Defined in [codec/Compact.ts:45](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L45)* **Parameters:** @@ -235,7 +235,7 @@ ___ ▸ **with**(Type: *[Constructor](../modules/_types_.md#constructor)<[UInt](_codec_uint_.uint.md) | [Moment](_moment_.moment.md)>*): [Constructor](../modules/_types_.md#constructor)<[Compact](_codec_compact_.compact.md)> -*Defined in [codec/Compact.ts:28](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L28)* +*Defined in [codec/Compact.ts:28](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L28)* **Parameters:** diff --git a/docs/types/classes/_codec_enum_.enum.html b/docs/types/classes/_codec_enum_.enum.html index e27dd63ea5..08c0134194 100644 --- a/docs/types/classes/_codec_enum_.enum.html +++ b/docs/types/classes/_codec_enum_.enum.html @@ -2003,7 +2003,7 @@

constructor

⊕ new Enum(def: EnumDef, value?: Enum | Uint8Array | string | number): Enum

Overrides Base.constructor

-

Defined in codec/Enum.ts:29

+

Defined in codec/Enum.ts:29

Parameters:

@@ -2035,7 +2035,7 @@

encodedLength

getencodedLength(): number

-

Defined in codec/Enum.ts:64

+

Defined in codec/Enum.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2044,7 +2044,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Enum.ts:71

+

Defined in codec/Enum.ts:71

description: Returns a hex string representation of the value

Returns: string


@@ -2052,14 +2052,14 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Enum.ts:78

+

Defined in codec/Enum.ts:78

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


toNumber

▸ toNumber(): number

-

Defined in codec/Enum.ts:85

+

Defined in codec/Enum.ts:85

description: Returns the number representation for the value

Returns: number


@@ -2067,14 +2067,14 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/Enum.ts:92

+

Defined in codec/Enum.ts:92

description: Returns the string representation of the value

Returns: string


toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

-

Defined in codec/Enum.ts:100

+

Defined in codec/Enum.ts:100

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2100,7 +2100,7 @@

<Static> decodeEnum

▸ decodeEnum(def: EnumDef, value: Enum | Uint8Array | string | number): number | undefined

-

Defined in codec/Enum.ts:47

+

Defined in codec/Enum.ts:47

Parameters:

@@ -2168,7 +2168,7 @@ diff --git a/docs/types/classes/_codec_enum_.enum.md b/docs/types/classes/_codec_enum_.enum.md index 958269a005..9809811999 100644 --- a/docs/types/classes/_codec_enum_.enum.md +++ b/docs/types/classes/_codec_enum_.enum.md @@ -30,7 +30,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Enum.ts:29](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L29)* +*Defined in [codec/Enum.ts:29](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L29)* **Parameters:** @@ -51,7 +51,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L64)* +*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -69,7 +69,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L71)* +*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L71)* *__description__*: Returns a hex string representation of the value @@ -84,7 +84,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L78)* +*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L78)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -97,7 +97,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [codec/Enum.ts:85](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L85)* +*Defined in [codec/Enum.ts:85](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L85)* *__description__*: Returns the number representation for the value @@ -112,7 +112,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [codec/Enum.ts:92](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L92)* +*Defined in [codec/Enum.ts:92](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L92)* *__description__*: Returns the string representation of the value @@ -125,7 +125,7 @@ ___ ▸ **toU8a**(isBare?: *`undefined` | `false` | `true`*): `Uint8Array` -*Defined in [codec/Enum.ts:100](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L100)* +*Defined in [codec/Enum.ts:100](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L100)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -144,7 +144,7 @@ ___ ▸ **decodeEnum**(def: *`EnumDef`*, value: *[Enum](_codec_enum_.enum.md) | `Uint8Array` | `string` | `number`*): `number` | `undefined` -*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L47)* +*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L47)* **Parameters:** diff --git a/docs/types/classes/_codec_enumtype_.enumtype.html b/docs/types/classes/_codec_enumtype_.enumtype.html index 3435fb06d3..48aab6f4c3 100644 --- a/docs/types/classes/_codec_enumtype_.enumtype.html +++ b/docs/types/classes/_codec_enumtype_.enumtype.html @@ -2008,7 +2008,7 @@

constructor

⊕ new EnumType(def: TypesDef, value?: any, index?: number | EnumType<T>): EnumType

Overrides Base.constructor

-

Defined in codec/EnumType.ts:32

+

Defined in codec/EnumType.ts:32

Parameters:

@@ -2039,35 +2039,35 @@

encodedLength

getencodedLength(): number

-

Defined in codec/EnumType.ts:97

+

Defined in codec/EnumType.ts:97

description: The length of the value when encoded as a Uint8Array

Returns: number


isNone

getisNone(): boolean

-

Defined in codec/EnumType.ts:104

+

Defined in codec/EnumType.ts:104

description: Checks if the Enum points to a Null type

Returns: boolean


isNull

getisNull(): boolean

-

Defined in codec/EnumType.ts:111

+

Defined in codec/EnumType.ts:111

description: Checks if the Enum points to a Null type (deprecated, use isNone)

Returns: boolean


type

gettype(): string

-

Defined in codec/EnumType.ts:118

+

Defined in codec/EnumType.ts:118

description: The name of the type this enum value represents

Returns: string


value

getvalue(): Codec

-

Defined in codec/EnumType.ts:125

+

Defined in codec/EnumType.ts:125

description: The value of the enum

Returns: Codec


@@ -2076,7 +2076,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/EnumType.ts:132

+

Defined in codec/EnumType.ts:132

description: Returns a hex string representation of the value

Returns: string


@@ -2084,14 +2084,14 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/EnumType.ts:139

+

Defined in codec/EnumType.ts:139

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


toNumber

▸ toNumber(): number

-

Defined in codec/EnumType.ts:146

+

Defined in codec/EnumType.ts:146

description: Returns the number representation for the value

Returns: number


@@ -2099,14 +2099,14 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/EnumType.ts:153

+

Defined in codec/EnumType.ts:153

description: Returns the string representation of the value

Returns: string


toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

-

Defined in codec/EnumType.ts:161

+

Defined in codec/EnumType.ts:161

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2172,7 +2172,7 @@ diff --git a/docs/types/classes/_codec_enumtype_.enumtype.md b/docs/types/classes/_codec_enumtype_.enumtype.md index 87dab0e686..e42c00538f 100644 --- a/docs/types/classes/_codec_enumtype_.enumtype.md +++ b/docs/types/classes/_codec_enumtype_.enumtype.md @@ -38,7 +38,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/EnumType.ts:32](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L32)* +*Defined in [codec/EnumType.ts:32](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L32)* **Parameters:** @@ -60,7 +60,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L97)* +*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L97)* *__description__*: The length of the value when encoded as a Uint8Array @@ -73,7 +73,7 @@ ___ getisNone(): `boolean` -*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L104)* +*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L104)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type @@ -86,7 +86,7 @@ ___ getisNull(): `boolean` -*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L111)* +*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L111)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone) @@ -99,7 +99,7 @@ ___ gettype(): `string` -*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L118)* +*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L118)* *__description__*: The name of the type this enum value represents @@ -112,7 +112,7 @@ ___ getvalue(): [Codec](../interfaces/_types_.codec.md) -*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L125)* +*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L125)* *__description__*: The value of the enum @@ -130,7 +130,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L132)* +*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L132)* *__description__*: Returns a hex string representation of the value @@ -145,7 +145,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L139)* +*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L139)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -158,7 +158,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L146)* +*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L146)* *__description__*: Returns the number representation for the value @@ -173,7 +173,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [codec/EnumType.ts:153](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L153)* +*Defined in [codec/EnumType.ts:153](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L153)* *__description__*: Returns the string representation of the value @@ -186,7 +186,7 @@ ___ ▸ **toU8a**(isBare?: *`undefined` | `false` | `true`*): `Uint8Array` -*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L161)* +*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L161)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_codec_int_.int.md b/docs/types/classes/_codec_int_.int.md index 91871d2e84..3747c44c9d 100644 --- a/docs/types/classes/_codec_int_.int.md +++ b/docs/types/classes/_codec_int_.int.md @@ -36,7 +36,7 @@ *Overrides AbstractInt.__constructor* -*Defined in [codec/Int.ts:21](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Int.ts#L21)* +*Defined in [codec/Int.ts:21](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Int.ts#L21)* **Parameters:** @@ -62,7 +62,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -77,7 +77,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_codec_option_.option.html b/docs/types/classes/_codec_option_.option.html index bb8a061b25..8bb53f239b 100644 --- a/docs/types/classes/_codec_option_.option.html +++ b/docs/types/classes/_codec_option_.option.html @@ -2002,7 +2002,7 @@

constructor

⊕ new Option(Type: Constructor, value?: any): Option

Overrides Base.constructor

-

Defined in codec/Option.ts:19

+

Defined in codec/Option.ts:19

Parameters:

@@ -2028,28 +2028,28 @@

encodedLength

getencodedLength(): number

-

Defined in codec/Option.ts:52

+

Defined in codec/Option.ts:52

description: The length of the value when encoded as a Uint8Array

Returns: number


isNone

getisNone(): boolean

-

Defined in codec/Option.ts:60

+

Defined in codec/Option.ts:60

description: Checks if the Option has no value

Returns: boolean


isSome

getisSome(): boolean

-

Defined in codec/Option.ts:67

+

Defined in codec/Option.ts:67

description: Checks if the Option has a value

Returns: boolean


value

getvalue(): Codec

-

Defined in codec/Option.ts:74

+

Defined in codec/Option.ts:74

description: The actual value for the Option

Returns: Codec


@@ -2058,7 +2058,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Option.ts:81

+

Defined in codec/Option.ts:81

description: Returns a hex string representation of the value

Returns: string


@@ -2066,7 +2066,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Option.ts:88

+

Defined in codec/Option.ts:88

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2074,14 +2074,14 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/Option.ts:95

+

Defined in codec/Option.ts:95

description: Returns the string representation of the value

Returns: string


toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

-

Defined in codec/Option.ts:103

+

Defined in codec/Option.ts:103

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2107,14 +2107,14 @@

unwrap

▸ unwrap(): T

-

Defined in codec/Option.ts:121

+

Defined in codec/Option.ts:121

description: Returns the value that the Option represents (if available)

Returns: T


<Static> decodeOption

▸ decodeOption<O>(Type: Constructor, value?: any): Codec

-

Defined in codec/Option.ts:26

+

Defined in codec/Option.ts:26

Type parameters:

O

Parameters:

@@ -2141,7 +2141,7 @@

<Static> with

▸ with<O>(Type: Constructor): Constructor<Option<O>>

-

Defined in codec/Option.ts:41

+

Defined in codec/Option.ts:41

Type parameters:

O : Codec

Parameters:

@@ -2204,7 +2204,7 @@ diff --git a/docs/types/classes/_codec_option_.option.md b/docs/types/classes/_codec_option_.option.md index 152e880730..222cc4ba0e 100644 --- a/docs/types/classes/_codec_option_.option.md +++ b/docs/types/classes/_codec_option_.option.md @@ -26,7 +26,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Option.ts:19](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Option.ts#L19)* +*Defined in [codec/Option.ts:19](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Option.ts#L19)* **Parameters:** @@ -47,7 +47,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Option.ts:52](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Option.ts#L52)* +*Defined in [codec/Option.ts:52](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Option.ts#L52)* *__description__*: The length of the value when encoded as a Uint8Array @@ -60,7 +60,7 @@ ___ getisNone(): `boolean` -*Defined in [codec/Option.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Option.ts#L60)* +*Defined in [codec/Option.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Option.ts#L60)* *__description__*: Checks if the Option has no value @@ -73,7 +73,7 @@ ___ getisSome(): `boolean` -*Defined in [codec/Option.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Option.ts#L67)* +*Defined in [codec/Option.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Option.ts#L67)* *__description__*: Checks if the Option has a value @@ -86,7 +86,7 @@ ___ getvalue(): [Codec](../interfaces/_types_.codec.md) -*Defined in [codec/Option.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Option.ts#L74)* +*Defined in [codec/Option.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Option.ts#L74)* *__description__*: The actual value for the Option @@ -104,7 +104,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Option.ts:81](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Option.ts#L81)* +*Defined in [codec/Option.ts:81](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Option.ts#L81)* *__description__*: Returns a hex string representation of the value @@ -119,7 +119,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Option.ts:88](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Option.ts#L88)* +*Defined in [codec/Option.ts:88](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Option.ts#L88)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -134,7 +134,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [codec/Option.ts:95](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Option.ts#L95)* +*Defined in [codec/Option.ts:95](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Option.ts#L95)* *__description__*: Returns the string representation of the value @@ -147,7 +147,7 @@ ___ ▸ **toU8a**(isBare?: *`undefined` | `false` | `true`*): `Uint8Array` -*Defined in [codec/Option.ts:103](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Option.ts#L103)* +*Defined in [codec/Option.ts:103](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Option.ts#L103)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -166,7 +166,7 @@ ___ ▸ **unwrap**(): `T` -*Defined in [codec/Option.ts:121](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Option.ts#L121)* +*Defined in [codec/Option.ts:121](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Option.ts#L121)* *__description__*: Returns the value that the Option represents (if available) @@ -179,7 +179,7 @@ ___ ▸ **decodeOption**<`O`>(Type: *[Constructor](../modules/_types_.md#constructor)*, value?: *`any`*): [Codec](../interfaces/_types_.codec.md) -*Defined in [codec/Option.ts:26](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Option.ts#L26)* +*Defined in [codec/Option.ts:26](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Option.ts#L26)* **Type parameters:** @@ -200,7 +200,7 @@ ___ ▸ **with**<`O`>(Type: *[Constructor](../modules/_types_.md#constructor)*): [Constructor](../modules/_types_.md#constructor)<[Option](_codec_option_.option.md)<`O`>> -*Defined in [codec/Option.ts:41](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Option.ts#L41)* +*Defined in [codec/Option.ts:41](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Option.ts#L41)* **Type parameters:** diff --git a/docs/types/classes/_codec_set_.set.html b/docs/types/classes/_codec_set_.set.html index dd365f1b16..98e587cfa9 100644 --- a/docs/types/classes/_codec_set_.set.html +++ b/docs/types/classes/_codec_set_.set.html @@ -2000,7 +2000,7 @@

constructor

⊕ new Set(setValues: SetValues, value?: Array<string> | Uint8Array | number): Set

Overrides Base.constructor

-

Defined in codec/Set.ts:22

+

Defined in codec/Set.ts:22

Parameters:

@@ -2028,28 +2028,28 @@

encodedLength

getencodedLength(): number

-

Defined in codec/Set.ts:72

+

Defined in codec/Set.ts:72

description: The length of the value when encoded as a Uint8Array

Returns: number


isEmpty

getisEmpty(): boolean

-

Defined in codec/Set.ts:79

+

Defined in codec/Set.ts:79

description: true is the Set contains no values

Returns: boolean


valueEncoded

getvalueEncoded(): number

-

Defined in codec/Set.ts:93

+

Defined in codec/Set.ts:93

description: The encoded value for the set members

Returns: number


values

getvalues(): Array<string>

-

Defined in codec/Set.ts:86

+

Defined in codec/Set.ts:86

description: The actual set values as a Array

Returns: Array<string>


@@ -2058,7 +2058,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Set.ts:100

+

Defined in codec/Set.ts:100

description: Returns a hex string representation of the value

Returns: string


@@ -2066,7 +2066,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Set.ts:107

+

Defined in codec/Set.ts:107

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2074,14 +2074,14 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/Set.ts:114

+

Defined in codec/Set.ts:114

description: Returns the string representation of the value

Returns: string


toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

-

Defined in codec/Set.ts:122

+

Defined in codec/Set.ts:122

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2107,7 +2107,7 @@

<Static> decodeSet

▸ decodeSet(setValues: SetValues, value?: Array<string> | Uint8Array | number): Array<string>

-

Defined in codec/Set.ts:32

+

Defined in codec/Set.ts:32

Parameters:

@@ -2137,7 +2137,7 @@

<Static> encodeSet

▸ encodeSet(setValues: SetValues, value: Array<string>): number

-

Defined in codec/Set.ts:63

+

Defined in codec/Set.ts:63

Parameters:

@@ -2202,7 +2202,7 @@ diff --git a/docs/types/classes/_codec_set_.set.md b/docs/types/classes/_codec_set_.set.md index f8c9b127bb..ff7b461a1d 100644 --- a/docs/types/classes/_codec_set_.set.md +++ b/docs/types/classes/_codec_set_.set.md @@ -24,7 +24,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Set.ts:22](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Set.ts#L22)* +*Defined in [codec/Set.ts:22](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Set.ts#L22)* **Parameters:** @@ -45,7 +45,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Set.ts:72](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Set.ts#L72)* +*Defined in [codec/Set.ts:72](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Set.ts#L72)* *__description__*: The length of the value when encoded as a Uint8Array @@ -58,7 +58,7 @@ ___ getisEmpty(): `boolean` -*Defined in [codec/Set.ts:79](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Set.ts#L79)* +*Defined in [codec/Set.ts:79](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Set.ts#L79)* *__description__*: true is the Set contains no values @@ -71,7 +71,7 @@ ___ getvalueEncoded(): `number` -*Defined in [codec/Set.ts:93](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Set.ts#L93)* +*Defined in [codec/Set.ts:93](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Set.ts#L93)* *__description__*: The encoded value for the set members @@ -84,7 +84,7 @@ ___ getvalues(): `Array`<`string`> -*Defined in [codec/Set.ts:86](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Set.ts#L86)* +*Defined in [codec/Set.ts:86](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Set.ts#L86)* *__description__*: The actual set values as a Array @@ -102,7 +102,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Set.ts:100](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Set.ts#L100)* +*Defined in [codec/Set.ts:100](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Set.ts#L100)* *__description__*: Returns a hex string representation of the value @@ -117,7 +117,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Set.ts:107](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Set.ts#L107)* +*Defined in [codec/Set.ts:107](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Set.ts#L107)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -132,7 +132,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [codec/Set.ts:114](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Set.ts#L114)* +*Defined in [codec/Set.ts:114](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Set.ts#L114)* *__description__*: Returns the string representation of the value @@ -145,7 +145,7 @@ ___ ▸ **toU8a**(isBare?: *`undefined` | `false` | `true`*): `Uint8Array` -*Defined in [codec/Set.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Set.ts#L122)* +*Defined in [codec/Set.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Set.ts#L122)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -164,7 +164,7 @@ ___ ▸ **decodeSet**(setValues: *`SetValues`*, value?: *`Array`<`string`> | `Uint8Array` | `number`*): `Array`<`string`> -*Defined in [codec/Set.ts:32](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Set.ts#L32)* +*Defined in [codec/Set.ts:32](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Set.ts#L32)* **Parameters:** @@ -182,7 +182,7 @@ ___ ▸ **encodeSet**(setValues: *`SetValues`*, value: *`Array`<`string`>*): `number` -*Defined in [codec/Set.ts:63](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Set.ts#L63)* +*Defined in [codec/Set.ts:63](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Set.ts#L63)* **Parameters:** diff --git a/docs/types/classes/_codec_struct_.struct.html b/docs/types/classes/_codec_struct_.struct.html index b04ff89d90..2c67a01bf2 100644 --- a/docs/types/classes/_codec_struct_.struct.html +++ b/docs/types/classes/_codec_struct_.struct.html @@ -2040,7 +2040,7 @@

constructor

⊕ new Struct(Types: S, value?: V | Map<any, any> | Array<any>, jsonMap?: Map<keyof S, string>): Struct

-

Defined in codec/Struct.ts:31

+

Defined in codec/Struct.ts:31

Parameters:

@@ -2082,14 +2082,14 @@

Type

getType(): E

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


encodedLength

getencodedLength(): number

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2098,7 +2098,7 @@

get

▸ get(name: keyof S): Codec | undefined

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2122,7 +2122,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2144,7 +2144,7 @@

toArray

▸ toArray(): Array<Codec>

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2152,7 +2152,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2160,7 +2160,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2168,14 +2168,14 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2201,7 +2201,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2264,7 +2264,7 @@ diff --git a/docs/types/classes/_codec_struct_.struct.md b/docs/types/classes/_codec_struct_.struct.md index 9365a08e31..7ca0382af5 100644 --- a/docs/types/classes/_codec_struct_.struct.md +++ b/docs/types/classes/_codec_struct_.struct.md @@ -99,7 +99,7 @@ ⊕ **new Struct**(Types: *`S`*, value?: *`V` | `Map`<`any`, `any`> | `Array`<`any`>*, jsonMap?: *`Map`<`keyof S`, `string`>*): [Struct](_codec_struct_.struct.md) -*Defined in [codec/Struct.ts:31](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L31)* +*Defined in [codec/Struct.ts:31](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L31)* **Parameters:** @@ -133,7 +133,7 @@ ___ getType(): `E` -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -146,7 +146,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -164,7 +164,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -183,7 +183,7 @@ ___ ▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -202,7 +202,7 @@ ___ ▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -217,7 +217,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -232,7 +232,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -247,7 +247,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -260,7 +260,7 @@ ___ ▸ **toU8a**(isBare?: *`undefined` | `false` | `true`*): `Uint8Array` -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -279,7 +279,7 @@ ___ ▸ **with**<`S`>(Types: *`S`*): [Constructor](../modules/_types_.md#constructor)<[Struct](_codec_struct_.struct.md)<`S`>> -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_codec_tuple_.tuple.html b/docs/types/classes/_codec_tuple_.tuple.html index 6efa32051a..f408f2ecef 100644 --- a/docs/types/classes/_codec_tuple_.tuple.html +++ b/docs/types/classes/_codec_tuple_.tuple.html @@ -2014,7 +2014,7 @@

constructor

⊕ new Tuple(Types: TupleConstructors, value: any): Tuple

-

Defined in codec/Tuple.ts:22

+

Defined in codec/Tuple.ts:22

Parameters:

@@ -2046,14 +2046,14 @@

Types

getTypes(): Array<string>

-

Defined in codec/Tuple.ts:68

+

Defined in codec/Tuple.ts:68

description: The types definition of the tuple

Returns: Array<string>


encodedLength

getencodedLength(): number

-

Defined in codec/Tuple.ts:59

+

Defined in codec/Tuple.ts:59

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2062,7 +2062,7 @@

filter

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Overrides Array.filter

-

Defined in codec/Tuple.ts:126

+

Defined in codec/Tuple.ts:126

description: Filters the array with the callback

Parameters:

@@ -2092,7 +2092,7 @@

map

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Overrides Array.map

-

Defined in codec/Tuple.ts:135

+

Defined in codec/Tuple.ts:135

description: Maps the array with the callback

Type parameters:

U

@@ -2123,7 +2123,7 @@

toArray

▸ toArray(): Array<Codec>

-

Defined in codec/Tuple.ts:77

+

Defined in codec/Tuple.ts:77

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2131,7 +2131,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Tuple.ts:84

+

Defined in codec/Tuple.ts:84

description: Returns a hex string representation of the value

Returns: string


@@ -2139,7 +2139,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Tuple.ts:91

+

Defined in codec/Tuple.ts:91

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2148,14 +2148,14 @@

▸ toString(): string

Implementation of Codec.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:100

+

Defined in codec/Tuple.ts:100

description: Returns the string representation of the value

Returns: string


toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

-

Defined in codec/Tuple.ts:109

+

Defined in codec/Tuple.ts:109

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2181,7 +2181,7 @@

<Static> with

▸ with(Types: TupleConstructors): Constructor<Tuple>

-

Defined in codec/Tuple.ts:48

+

Defined in codec/Tuple.ts:48

Parameters:

@@ -2242,7 +2242,7 @@ diff --git a/docs/types/classes/_codec_tuple_.tuple.md b/docs/types/classes/_codec_tuple_.tuple.md index bca8826f34..255933bd82 100644 --- a/docs/types/classes/_codec_tuple_.tuple.md +++ b/docs/types/classes/_codec_tuple_.tuple.md @@ -51,7 +51,7 @@ ⊕ **new Tuple**(Types: *`TupleConstructors`*, value: *`any`*): [Tuple](_codec_tuple_.tuple.md) -*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L22)* +*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L22)* **Parameters:** @@ -84,7 +84,7 @@ ___ getTypes(): `Array`<`string`> -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -97,7 +97,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -115,7 +115,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L126)* +*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L126)* *__description__*: Filters the array with the callback @@ -137,7 +137,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L135)* +*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L135)* *__description__*: Maps the array with the callback @@ -160,7 +160,7 @@ ___ ▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Converts the Object to an standard JavaScript Array @@ -175,7 +175,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Returns a hex string representation of the value @@ -190,7 +190,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -207,7 +207,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L100)* +*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L100)* *__description__*: Returns the string representation of the value @@ -220,7 +220,7 @@ ___ ▸ **toU8a**(isBare?: *`undefined` | `false` | `true`*): `Uint8Array` -*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L109)* +*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L109)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -239,7 +239,7 @@ ___ ▸ **with**(Types: *`TupleConstructors`*): [Constructor](../modules/_types_.md#constructor)<[Tuple](_codec_tuple_.tuple.md)> -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_codec_typeregistry_.typeregistry.html b/docs/types/classes/_codec_typeregistry_.typeregistry.html index 927221b707..ee84994df2 100644 --- a/docs/types/classes/_codec_typeregistry_.typeregistry.html +++ b/docs/types/classes/_codec_typeregistry_.typeregistry.html @@ -1992,13 +1992,13 @@

<Static> defaultRegistry

● defaultRegistry: TypeRegistry = new TypeRegistry()

-

Defined in codec/typeRegistry.ts:16

+

Defined in codec/typeRegistry.ts:16


Methods

get

▸ get(name: string): Constructor | undefined

-

Defined in codec/typeRegistry.ts:51

+

Defined in codec/typeRegistry.ts:51

Parameters:

@@ -2020,7 +2020,7 @@

register

▸ register(type: Constructor | ConstructorObj): void

▸ register(name: string, type: Constructor): void

-

Defined in codec/typeRegistry.ts:20

+

Defined in codec/typeRegistry.ts:20

Parameters:

@@ -2038,7 +2038,7 @@

Returns: void

-

Defined in codec/typeRegistry.ts:21

+

Defined in codec/typeRegistry.ts:21

Parameters:

@@ -2103,7 +2103,7 @@ diff --git a/docs/types/classes/_codec_typeregistry_.typeregistry.md b/docs/types/classes/_codec_typeregistry_.typeregistry.md index 8cf8f2b366..f17c5d740e 100644 --- a/docs/types/classes/_codec_typeregistry_.typeregistry.md +++ b/docs/types/classes/_codec_typeregistry_.typeregistry.md @@ -12,7 +12,7 @@ **● defaultRegistry**: *[TypeRegistry](_codec_typeregistry_.typeregistry.md)* = new TypeRegistry() -*Defined in [codec/typeRegistry.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/typeRegistry.ts#L16)* +*Defined in [codec/typeRegistry.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/typeRegistry.ts#L16)* ___ @@ -24,7 +24,7 @@ ___ ▸ **get**(name: *`string`*): [Constructor](../modules/_types_.md#constructor) | `undefined` -*Defined in [codec/typeRegistry.ts:51](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/typeRegistry.ts#L51)* +*Defined in [codec/typeRegistry.ts:51](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/typeRegistry.ts#L51)* **Parameters:** @@ -43,7 +43,7 @@ ___ ▸ **register**(name: *`string`*, type: *[Constructor](../modules/_types_.md#constructor)*): `void` -*Defined in [codec/typeRegistry.ts:20](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/typeRegistry.ts#L20)* +*Defined in [codec/typeRegistry.ts:20](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/typeRegistry.ts#L20)* **Parameters:** @@ -53,7 +53,7 @@ ___ **Returns:** `void` -*Defined in [codec/typeRegistry.ts:21](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/typeRegistry.ts#L21)* +*Defined in [codec/typeRegistry.ts:21](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/typeRegistry.ts#L21)* **Parameters:** diff --git a/docs/types/classes/_codec_u8a_.u8a.html b/docs/types/classes/_codec_u8a_.u8a.html index 56fd2f16db..6f3476fbbf 100644 --- a/docs/types/classes/_codec_u8a_.u8a.html +++ b/docs/types/classes/_codec_u8a_.u8a.html @@ -2005,7 +2005,7 @@

constructor

⊕ new U8a(value?: AnyU8a): U8a

-

Defined in codec/U8a.ts:18

+

Defined in codec/U8a.ts:18

Parameters:

@@ -2033,7 +2033,7 @@

encodedLength

getencodedLength(): number

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2041,7 +2041,7 @@

length

getlength(): number

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2050,7 +2050,7 @@

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2081,7 +2081,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2089,7 +2089,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2098,14 +2098,14 @@

▸ toString(): string

Implementation of Codec.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2171,7 +2171,7 @@ diff --git a/docs/types/classes/_codec_u8a_.u8a.md b/docs/types/classes/_codec_u8a_.u8a.md index e14cd09e57..d51311a4db 100644 --- a/docs/types/classes/_codec_u8a_.u8a.md +++ b/docs/types/classes/_codec_u8a_.u8a.md @@ -33,7 +33,7 @@ ⊕ **new U8a**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [U8a](_codec_u8a_.u8a.md) -*Defined in [codec/U8a.ts:18](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L18)* +*Defined in [codec/U8a.ts:18](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L18)* **Parameters:** @@ -65,7 +65,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -80,7 +80,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -98,7 +98,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -120,7 +120,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -135,7 +135,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -152,7 +152,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -165,7 +165,7 @@ ___ ▸ **toU8a**(isBare?: *`undefined` | `false` | `true`*): `Uint8Array` -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_codec_u8afixed_.u8afixed.html b/docs/types/classes/_codec_u8afixed_.u8afixed.html index a97483ab8e..7e50fce2cd 100644 --- a/docs/types/classes/_codec_u8afixed_.u8afixed.html +++ b/docs/types/classes/_codec_u8afixed_.u8afixed.html @@ -2008,7 +2008,7 @@

constructor

⊕ new U8aFixed(value?: AnyU8a, bitLength?: BitLength): U8aFixed

Overrides U8a.constructor

-

Defined in codec/U8aFixed.ts:19

+

Defined in codec/U8aFixed.ts:19

Parameters:

@@ -2038,7 +2038,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2047,7 +2047,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2055,7 +2055,7 @@

bitLength

▸ bitLength(): number

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2064,7 +2064,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2096,7 +2096,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2105,7 +2105,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2115,7 +2115,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2123,7 +2123,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2189,7 +2189,7 @@ diff --git a/docs/types/classes/_codec_u8afixed_.u8afixed.md b/docs/types/classes/_codec_u8afixed_.u8afixed.md index 7a712d4751..f7e800ea1a 100644 --- a/docs/types/classes/_codec_u8afixed_.u8afixed.md +++ b/docs/types/classes/_codec_u8afixed_.u8afixed.md @@ -39,7 +39,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [codec/U8aFixed.ts:19](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8aFixed.ts#L19)* +*Defined in [codec/U8aFixed.ts:19](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8aFixed.ts#L19)* **Parameters:** @@ -62,7 +62,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -79,7 +79,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -95,7 +95,7 @@ ___ ▸ **bitLength**(): `number` -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -112,7 +112,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -136,7 +136,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -153,7 +153,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -172,7 +172,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -187,7 +187,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_codec_uint_.uint.html b/docs/types/classes/_codec_uint_.uint.html index 77cf739a8f..90eaec6209 100644 --- a/docs/types/classes/_codec_uint_.uint.html +++ b/docs/types/classes/_codec_uint_.uint.html @@ -2006,7 +2006,7 @@

constructor

⊕ new UInt(value?: AnyNumber, bitLength?: UIntBitLength, isHexJson?: boolean): UInt

Overrides AbstractInt.__constructor

-

Defined in codec/UInt.ts:21

+

Defined in codec/UInt.ts:21

Parameters:

@@ -2042,7 +2042,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2050,7 +2050,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2116,7 +2116,7 @@ diff --git a/docs/types/classes/_codec_uint_.uint.md b/docs/types/classes/_codec_uint_.uint.md index c4eea23d3e..2f2609e67a 100644 --- a/docs/types/classes/_codec_uint_.uint.md +++ b/docs/types/classes/_codec_uint_.uint.md @@ -36,7 +36,7 @@ *Overrides AbstractInt.__constructor* -*Defined in [codec/UInt.ts:21](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L21)* +*Defined in [codec/UInt.ts:21](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L21)* **Parameters:** @@ -62,7 +62,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -77,7 +77,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_codec_vector_.vector.html b/docs/types/classes/_codec_vector_.vector.html index b99d2340c3..43ccc27b81 100644 --- a/docs/types/classes/_codec_vector_.vector.html +++ b/docs/types/classes/_codec_vector_.vector.html @@ -2006,7 +2006,7 @@

constructor

⊕ new Vector(Type: Constructor<T>, value?: Vector<any> | Uint8Array | string | Array<any>): Vector

-

Defined in codec/Vector.ts:22

+

Defined in codec/Vector.ts:22

Parameters:

@@ -2044,13 +2044,13 @@

Type

getType(): string

-

Defined in codec/Vector.ts:57

+

Defined in codec/Vector.ts:57

Returns: string


encodedLength

getencodedLength(): number

-

Defined in codec/Vector.ts:64

+

Defined in codec/Vector.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2058,7 +2058,7 @@

length

getlength(): number

Overrides Array.length

-

Defined in codec/Vector.ts:73

+

Defined in codec/Vector.ts:73

description: The length of the value

Returns: number


@@ -2067,7 +2067,7 @@

filter

▸ filter(callbackfn: function, thisArg?: any): Array<T>

Overrides Array.filter

-

Defined in codec/Vector.ts:139

+

Defined in codec/Vector.ts:139

description: Filters the array with the callback

Parameters:

@@ -2097,7 +2097,7 @@

map

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Overrides Array.map

-

Defined in codec/Vector.ts:148

+

Defined in codec/Vector.ts:148

description: Maps the array with the callback

Type parameters:

U

@@ -2128,7 +2128,7 @@

toArray

▸ toArray(): Array<T>

-

Defined in codec/Vector.ts:81

+

Defined in codec/Vector.ts:81

description: Converts the Object to an standard JavaScript Array

Returns: Array<T>


@@ -2136,7 +2136,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Vector.ts:88

+

Defined in codec/Vector.ts:88

description: Returns a hex string representation of the value

Returns: string


@@ -2144,7 +2144,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Vector.ts:95

+

Defined in codec/Vector.ts:95

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2153,14 +2153,14 @@

▸ toString(): string

Implementation of Codec.toString

Overrides Array.toString

-

Defined in codec/Vector.ts:104

+

Defined in codec/Vector.ts:104

description: Returns the string representation of the value

Returns: string


toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

-

Defined in codec/Vector.ts:117

+

Defined in codec/Vector.ts:117

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2186,7 +2186,7 @@

<Static> decodeVector

▸ decodeVector<T>(Type: Constructor<T>, value: Vector<any> | Uint8Array | string | Array<any>): Array<T>

-

Defined in codec/Vector.ts:32

+

Defined in codec/Vector.ts:32

Type parameters:

T : Codec

Parameters:

@@ -2216,7 +2216,7 @@

<Static> with

▸ with<O>(Type: Constructor<O>): Constructor<Vector<O>>

-

Defined in codec/Vector.ts:49

+

Defined in codec/Vector.ts:49

Type parameters:

O : Codec

Parameters:

@@ -2279,7 +2279,7 @@ diff --git a/docs/types/classes/_codec_vector_.vector.md b/docs/types/classes/_codec_vector_.vector.md index 2e62e5c93a..b6248d50df 100644 --- a/docs/types/classes/_codec_vector_.vector.md +++ b/docs/types/classes/_codec_vector_.vector.md @@ -33,7 +33,7 @@ ⊕ **new Vector**(Type: *[Constructor](../modules/_types_.md#constructor)<`T`>*, value?: *[Vector](_codec_vector_.vector.md)<`any`> | `Uint8Array` | `string` | `Array`<`any`>*): [Vector](_codec_vector_.vector.md) -*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L22)* +*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L22)* **Parameters:** @@ -66,7 +66,7 @@ ___ getType(): `string` -*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L57)* +*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L57)* **Returns:** `string` @@ -77,7 +77,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L64)* +*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -92,7 +92,7 @@ getlength(): `number` *Overrides Array.length* -*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L73)* +*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L73)* *__description__*: The length of the value @@ -110,7 +110,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L139)* +*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L139)* *__description__*: Filters the array with the callback @@ -132,7 +132,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L148)* +*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L148)* *__description__*: Maps the array with the callback @@ -155,7 +155,7 @@ ___ ▸ **toArray**(): `Array`<`T`> -*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L81)* +*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L81)* *__description__*: Converts the Object to an standard JavaScript Array @@ -170,7 +170,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L88)* +*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L88)* *__description__*: Returns a hex string representation of the value @@ -185,7 +185,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L95)* +*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L95)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -202,7 +202,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L104)* +*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L104)* *__description__*: Returns the string representation of the value @@ -215,7 +215,7 @@ ___ ▸ **toU8a**(isBare?: *`undefined` | `false` | `true`*): `Uint8Array` -*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L117)* +*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L117)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -234,7 +234,7 @@ ___ ▸ **decodeVector**<`T`>(Type: *[Constructor](../modules/_types_.md#constructor)<`T`>*, value: *[Vector](_codec_vector_.vector.md)<`any`> | `Uint8Array` | `string` | `Array`<`any`>*): `Array`<`T`> -*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L32)* +*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L32)* **Type parameters:** @@ -255,7 +255,7 @@ ___ ▸ **with**<`O`>(Type: *[Constructor](../modules/_types_.md#constructor)<`O`>*): [Constructor](../modules/_types_.md#constructor)<[Vector](_codec_vector_.vector.md)<`O`>> -*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L49)* +*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L49)* **Type parameters:** diff --git a/docs/types/classes/_data_.data.html b/docs/types/classes/_data_.data.html index 5028585011..71ea4bd594 100644 --- a/docs/types/classes/_data_.data.html +++ b/docs/types/classes/_data_.data.html @@ -2002,7 +2002,7 @@

constructor

⊕ new Data(value?: AnyU8a): Data

Inherited from U8a.constructor

-

Defined in codec/U8a.ts:18

+

Defined in codec/U8a.ts:18

Parameters:

@@ -2025,7 +2025,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2034,7 +2034,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2044,7 +2044,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2076,7 +2076,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2085,7 +2085,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2095,7 +2095,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2103,7 +2103,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2169,7 +2169,7 @@ diff --git a/docs/types/classes/_data_.data.md b/docs/types/classes/_data_.data.md index 08ae84562d..f998130f5f 100644 --- a/docs/types/classes/_data_.data.md +++ b/docs/types/classes/_data_.data.md @@ -27,7 +27,7 @@ *Inherited from [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [codec/U8a.ts:18](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L18)* +*Defined in [codec/U8a.ts:18](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L18)* **Parameters:** @@ -49,7 +49,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -86,7 +86,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -110,7 +110,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -127,7 +127,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -146,7 +146,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -161,7 +161,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_digest_.authoritieschange.html b/docs/types/classes/_digest_.authoritieschange.html index 479034bc4b..40e2543805 100644 --- a/docs/types/classes/_digest_.authoritieschange.html +++ b/docs/types/classes/_digest_.authoritieschange.html @@ -2004,7 +2004,7 @@

constructor

⊕ new AuthoritiesChange(Type: Constructor<T>, value?: Vector<any> | Uint8Array | string | Array<any>): AuthoritiesChange

Inherited from Vector.constructor

-

Defined in codec/Vector.ts:22

+

Defined in codec/Vector.ts:22

Parameters:

@@ -2037,14 +2037,14 @@

Type

getType(): string

Inherited from Vector.Type

-

Defined in codec/Vector.ts:57

+

Defined in codec/Vector.ts:57

Returns: string


encodedLength

getencodedLength(): number

Inherited from Vector.encodedLength

-

Defined in codec/Vector.ts:64

+

Defined in codec/Vector.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2053,7 +2053,7 @@

getlength(): number

Inherited from Vector.length

Overrides Array.length

-

Defined in codec/Vector.ts:73

+

Defined in codec/Vector.ts:73

description: The length of the value

Returns: number


@@ -2063,7 +2063,7 @@

▸ filter(callbackfn: function, thisArg?: any): Array<T>

Inherited from Vector.filter

Overrides Array.filter

-

Defined in codec/Vector.ts:139

+

Defined in codec/Vector.ts:139

description: Filters the array with the callback

Parameters:

@@ -2094,7 +2094,7 @@

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Vector.map

Overrides Array.map

-

Defined in codec/Vector.ts:148

+

Defined in codec/Vector.ts:148

description: Maps the array with the callback

Type parameters:

U

@@ -2126,7 +2126,7 @@

toArray

▸ toArray(): Array<T>

Inherited from Vector.toArray

-

Defined in codec/Vector.ts:81

+

Defined in codec/Vector.ts:81

description: Converts the Object to an standard JavaScript Array

Returns: Array<T>


@@ -2135,7 +2135,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Vector.toHex

-

Defined in codec/Vector.ts:88

+

Defined in codec/Vector.ts:88

description: Returns a hex string representation of the value

Returns: string


@@ -2144,7 +2144,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Vector.toJSON

-

Defined in codec/Vector.ts:95

+

Defined in codec/Vector.ts:95

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2154,7 +2154,7 @@

Implementation of Codec.toString

Inherited from Vector.toString

Overrides Array.toString

-

Defined in codec/Vector.ts:104

+

Defined in codec/Vector.ts:104

description: Returns the string representation of the value

Returns: string


@@ -2162,7 +2162,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Vector.toU8a

-

Defined in codec/Vector.ts:117

+

Defined in codec/Vector.ts:117

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2189,7 +2189,7 @@

<Static> decodeVector

▸ decodeVector<T>(Type: Constructor<T>, value: Vector<any> | Uint8Array | string | Array<any>): Array<T>

Inherited from Vector.decodeVector

-

Defined in codec/Vector.ts:32

+

Defined in codec/Vector.ts:32

Type parameters:

T : Codec

Parameters:

@@ -2220,7 +2220,7 @@

<Static> with

▸ with<O>(Type: Constructor<O>): Constructor<Vector<O>>

Inherited from Vector.with

-

Defined in codec/Vector.ts:49

+

Defined in codec/Vector.ts:49

Type parameters:

O : Codec

Parameters:

@@ -2283,7 +2283,7 @@ diff --git a/docs/types/classes/_digest_.authoritieschange.md b/docs/types/classes/_digest_.authoritieschange.md index afd932c535..6562bf012f 100644 --- a/docs/types/classes/_digest_.authoritieschange.md +++ b/docs/types/classes/_digest_.authoritieschange.md @@ -29,7 +29,7 @@ *Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)* -*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L22)* +*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L22)* **Parameters:** @@ -52,7 +52,7 @@ getType(): `string` *Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* -*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L57)* +*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L57)* **Returns:** `string` @@ -65,7 +65,7 @@ getencodedLength(): `number` *Inherited from [Vector](_codec_vector_.vector.md).[encodedLength](_codec_vector_.vector.md#encodedlength)* -*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L64)* +*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -82,7 +82,7 @@ getlength(): `number` *Overrides Array.length* -*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L73)* +*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L73)* *__description__*: The length of the value @@ -102,7 +102,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L139)* +*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L139)* *__description__*: Filters the array with the callback @@ -126,7 +126,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L148)* +*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L148)* *__description__*: Maps the array with the callback @@ -151,7 +151,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)* -*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L81)* +*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L81)* *__description__*: Converts the Object to an standard JavaScript Array @@ -168,7 +168,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)* -*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L88)* +*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L88)* *__description__*: Returns a hex string representation of the value @@ -185,7 +185,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* -*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L95)* +*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L95)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -204,7 +204,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L104)* +*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L104)* *__description__*: Returns the string representation of the value @@ -219,7 +219,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* -*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L117)* +*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L117)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -240,7 +240,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[decodeVector](_codec_vector_.vector.md#decodevector)* -*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L32)* +*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L32)* **Type parameters:** @@ -263,7 +263,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* -*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L49)* +*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L49)* **Type parameters:** diff --git a/docs/types/classes/_digest_.changestrieroot.html b/docs/types/classes/_digest_.changestrieroot.html index b1fad76185..94696bfb56 100644 --- a/docs/types/classes/_digest_.changestrieroot.html +++ b/docs/types/classes/_digest_.changestrieroot.html @@ -2003,7 +2003,7 @@

⊕ new ChangesTrieRoot(value?: AnyU8a): ChangesTrieRoot

Inherited from H256.constructor

Overrides U8aFixed.constructor

-

Defined in H256.ts:15

+

Defined in H256.ts:15

Parameters:

@@ -2026,7 +2026,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2035,7 +2035,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2044,7 +2044,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2053,7 +2053,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2085,7 +2085,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2094,7 +2094,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2104,7 +2104,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2112,7 +2112,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2178,7 +2178,7 @@ diff --git a/docs/types/classes/_digest_.changestrieroot.md b/docs/types/classes/_digest_.changestrieroot.md index 6f6772e2c8..2e2fe5c997 100644 --- a/docs/types/classes/_digest_.changestrieroot.md +++ b/docs/types/classes/_digest_.changestrieroot.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/H256.ts#L15)* +*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/H256.ts#L15)* **Parameters:** @@ -51,7 +51,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -68,7 +68,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -86,7 +86,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -103,7 +103,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -127,7 +127,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -144,7 +144,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -163,7 +163,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -178,7 +178,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_digest_.digest.html b/docs/types/classes/_digest_.digest.html index d22f7c156d..a1168e6931 100644 --- a/docs/types/classes/_digest_.digest.html +++ b/docs/types/classes/_digest_.digest.html @@ -2005,7 +2005,7 @@

constructor

⊕ new Digest(value: any): Digest

Overrides Struct.constructor

-

Defined in Digest.ts:89

+

Defined in Digest.ts:89

Parameters:

@@ -2028,7 +2028,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2036,14 +2036,14 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


logs

getlogs(): Vector<DigestItem>

-

Defined in Digest.ts:99

+

Defined in Digest.ts:99

description: The DigestItem logs

Returns: Vector<DigestItem>


@@ -2053,7 +2053,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2078,7 +2078,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2101,7 +2101,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2110,7 +2110,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2119,7 +2119,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2128,7 +2128,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2136,7 +2136,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2163,7 +2163,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2226,7 +2226,7 @@ diff --git a/docs/types/classes/_digest_.digest.md b/docs/types/classes/_digest_.digest.md index 10e15ca950..8b8c6d39e2 100644 --- a/docs/types/classes/_digest_.digest.md +++ b/docs/types/classes/_digest_.digest.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Digest.ts:89](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Digest.ts#L89)* +*Defined in [Digest.ts:89](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Digest.ts#L89)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -66,7 +66,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -79,7 +79,7 @@ ___ getlogs(): [Vector](_codec_vector_.vector.md)<[DigestItem](_digest_.digestitem.md)> -*Defined in [Digest.ts:99](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Digest.ts#L99)* +*Defined in [Digest.ts:99](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Digest.ts#L99)* *__description__*: The [DigestItem](_digest_.digestitem.md) logs @@ -99,7 +99,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -120,7 +120,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -141,7 +141,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -158,7 +158,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -175,7 +175,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -192,7 +192,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -207,7 +207,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -228,7 +228,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_digest_.digestitem.html b/docs/types/classes/_digest_.digestitem.html index c51dcfaa7d..c10d107e65 100644 --- a/docs/types/classes/_digest_.digestitem.html +++ b/docs/types/classes/_digest_.digestitem.html @@ -2000,7 +2000,7 @@

constructor

⊕ new DigestItem(value: any): DigestItem

Overrides EnumType.constructor

-

Defined in Digest.ts:73

+

Defined in Digest.ts:73

Parameters:

@@ -2023,7 +2023,7 @@

encodedLength

getencodedLength(): number

Inherited from EnumType.encodedLength

-

Defined in codec/EnumType.ts:97

+

Defined in codec/EnumType.ts:97

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2031,7 +2031,7 @@

isNone

getisNone(): boolean

Inherited from EnumType.isNone

-

Defined in codec/EnumType.ts:104

+

Defined in codec/EnumType.ts:104

description: Checks if the Enum points to a Null type

Returns: boolean


@@ -2039,7 +2039,7 @@

isNull

getisNull(): boolean

Inherited from EnumType.isNull

-

Defined in codec/EnumType.ts:111

+

Defined in codec/EnumType.ts:111

description: Checks if the Enum points to a Null type (deprecated, use isNone)

Returns: boolean


@@ -2047,7 +2047,7 @@

type

gettype(): string

Inherited from EnumType.type

-

Defined in codec/EnumType.ts:118

+

Defined in codec/EnumType.ts:118

description: The name of the type this enum value represents

Returns: string


@@ -2055,7 +2055,7 @@

value

getvalue(): Codec

Inherited from EnumType.value

-

Defined in codec/EnumType.ts:125

+

Defined in codec/EnumType.ts:125

description: The value of the enum

Returns: Codec


@@ -2065,7 +2065,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from EnumType.toHex

-

Defined in codec/EnumType.ts:132

+

Defined in codec/EnumType.ts:132

description: Returns a hex string representation of the value

Returns: string


@@ -2074,7 +2074,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from EnumType.toJSON

-

Defined in codec/EnumType.ts:139

+

Defined in codec/EnumType.ts:139

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2082,7 +2082,7 @@

toNumber

▸ toNumber(): number

Inherited from EnumType.toNumber

-

Defined in codec/EnumType.ts:146

+

Defined in codec/EnumType.ts:146

description: Returns the number representation for the value

Returns: number


@@ -2091,7 +2091,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from EnumType.toString

-

Defined in codec/EnumType.ts:153

+

Defined in codec/EnumType.ts:153

description: Returns the string representation of the value

Returns: string


@@ -2099,7 +2099,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from EnumType.toU8a

-

Defined in codec/EnumType.ts:161

+

Defined in codec/EnumType.ts:161

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2165,7 +2165,7 @@ diff --git a/docs/types/classes/_digest_.digestitem.md b/docs/types/classes/_digest_.digestitem.md index 4776e5a629..70a2793fbf 100644 --- a/docs/types/classes/_digest_.digestitem.md +++ b/docs/types/classes/_digest_.digestitem.md @@ -24,7 +24,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [Digest.ts:73](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Digest.ts#L73)* +*Defined in [Digest.ts:73](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Digest.ts#L73)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* -*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L97)* +*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L97)* *__description__*: The length of the value when encoded as a Uint8Array @@ -61,7 +61,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L104)* +*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L104)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type @@ -76,7 +76,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L111)* +*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L111)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone) @@ -91,7 +91,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L118)* +*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L118)* *__description__*: The name of the type this enum value represents @@ -106,7 +106,7 @@ getvalue(): [Codec](../interfaces/_types_.codec.md) *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L125)* +*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L125)* *__description__*: The value of the enum @@ -126,7 +126,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L132)* +*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L132)* *__description__*: Returns a hex string representation of the value @@ -143,7 +143,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L139)* +*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L139)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -158,7 +158,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L146)* +*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L146)* *__description__*: Returns the number representation for the value @@ -175,7 +175,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [codec/EnumType.ts:153](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L153)* +*Defined in [codec/EnumType.ts:153](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L153)* *__description__*: Returns the string representation of the value @@ -190,7 +190,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L161)* +*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L161)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_digest_.other.html b/docs/types/classes/_digest_.other.html index fe4a3a8a28..a83ab58dc5 100644 --- a/docs/types/classes/_digest_.other.html +++ b/docs/types/classes/_digest_.other.html @@ -2003,7 +2003,7 @@

⊕ new Other(value?: AnyU8a): Other

Inherited from Bytes.constructor

Overrides U8a.constructor

-

Defined in Bytes.ts:18

+

Defined in Bytes.ts:18

Parameters:

@@ -2027,7 +2027,7 @@

getencodedLength(): number

Inherited from Bytes.encodedLength

Overrides U8a.encodedLength

-

Defined in Bytes.ts:64

+

Defined in Bytes.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2036,7 +2036,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2046,7 +2046,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2078,7 +2078,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2087,7 +2087,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2097,7 +2097,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2106,7 +2106,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Bytes.toU8a

Overrides U8a.toU8a

-

Defined in Bytes.ts:72

+

Defined in Bytes.ts:72

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2172,7 +2172,7 @@ diff --git a/docs/types/classes/_digest_.other.md b/docs/types/classes/_digest_.other.md index e3110d93bc..0a866e8c05 100644 --- a/docs/types/classes/_digest_.other.md +++ b/docs/types/classes/_digest_.other.md @@ -29,7 +29,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bytes.ts#L18)* +*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bytes.ts#L18)* **Parameters:** @@ -53,7 +53,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bytes.ts#L64)* +*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bytes.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -70,7 +70,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -90,7 +90,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -114,7 +114,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -131,7 +131,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -150,7 +150,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -167,7 +167,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bytes.ts#L72)* +*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bytes.ts#L72)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_digest_.seal.html b/docs/types/classes/_digest_.seal.html index b4f532e0d0..4717cb3e34 100644 --- a/docs/types/classes/_digest_.seal.html +++ b/docs/types/classes/_digest_.seal.html @@ -2002,7 +2002,7 @@

constructor

⊕ new Seal(value: any): Seal

Overrides Tuple.constructor

-

Defined in Digest.ts:44

+

Defined in Digest.ts:44

Parameters:

@@ -2025,7 +2025,7 @@

Types

getTypes(): Array<string>

Inherited from Tuple.Types

-

Defined in codec/Tuple.ts:68

+

Defined in codec/Tuple.ts:68

description: The types definition of the tuple

Returns: Array<string>


@@ -2033,21 +2033,21 @@

encodedLength

getencodedLength(): number

Inherited from Tuple.encodedLength

-

Defined in codec/Tuple.ts:59

+

Defined in codec/Tuple.ts:59

description: The length of the value when encoded as a Uint8Array

Returns: number


signature

getsignature(): Signature

-

Defined in Digest.ts:55

+

Defined in Digest.ts:55

description: The wrapped Signature

Returns: Signature


slot

getslot(): U64

-

Defined in Digest.ts:62

+

Defined in Digest.ts:62

description: The wrapped U64 slot

Returns: U64


@@ -2057,7 +2057,7 @@

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Inherited from Tuple.filter

Overrides Array.filter

-

Defined in codec/Tuple.ts:126

+

Defined in codec/Tuple.ts:126

description: Filters the array with the callback

Parameters:

@@ -2088,7 +2088,7 @@

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Tuple.map

Overrides Array.map

-

Defined in codec/Tuple.ts:135

+

Defined in codec/Tuple.ts:135

description: Maps the array with the callback

Type parameters:

U

@@ -2120,7 +2120,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

-

Defined in codec/Tuple.ts:77

+

Defined in codec/Tuple.ts:77

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2129,7 +2129,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

-

Defined in codec/Tuple.ts:84

+

Defined in codec/Tuple.ts:84

description: Returns a hex string representation of the value

Returns: string


@@ -2138,7 +2138,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

-

Defined in codec/Tuple.ts:91

+

Defined in codec/Tuple.ts:91

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2148,7 +2148,7 @@

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:100

+

Defined in codec/Tuple.ts:100

description: Returns the string representation of the value

Returns: string


@@ -2156,7 +2156,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Tuple.toU8a

-

Defined in codec/Tuple.ts:109

+

Defined in codec/Tuple.ts:109

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2183,7 +2183,7 @@

<Static> with

▸ with(Types: TupleConstructors): Constructor<Tuple>

Inherited from Tuple.with

-

Defined in codec/Tuple.ts:48

+

Defined in codec/Tuple.ts:48

Parameters:

@@ -2244,7 +2244,7 @@ diff --git a/docs/types/classes/_digest_.seal.md b/docs/types/classes/_digest_.seal.md index 4e77e477bb..862a2cfbcc 100644 --- a/docs/types/classes/_digest_.seal.md +++ b/docs/types/classes/_digest_.seal.md @@ -27,7 +27,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [Digest.ts:44](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Digest.ts#L44)* +*Defined in [Digest.ts:44](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Digest.ts#L44)* **Parameters:** @@ -49,7 +49,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -64,7 +64,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -77,7 +77,7 @@ ___ getsignature(): [Signature](_signature_.signature.md) -*Defined in [Digest.ts:55](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Digest.ts#L55)* +*Defined in [Digest.ts:55](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Digest.ts#L55)* *__description__*: The wrapped [Signature](_signature_.signature.md) @@ -90,7 +90,7 @@ ___ getslot(): [U64](_u64_.u64.md) -*Defined in [Digest.ts:62](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Digest.ts#L62)* +*Defined in [Digest.ts:62](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Digest.ts#L62)* *__description__*: The wrapped [U64](_u64_.u64.md) slot @@ -110,7 +110,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L126)* +*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L126)* *__description__*: Filters the array with the callback @@ -134,7 +134,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L135)* +*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L135)* *__description__*: Maps the array with the callback @@ -159,7 +159,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Converts the Object to an standard JavaScript Array @@ -176,7 +176,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Returns a hex string representation of the value @@ -193,7 +193,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -212,7 +212,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L100)* +*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L100)* *__description__*: Returns the string representation of the value @@ -227,7 +227,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L109)* +*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L109)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -248,7 +248,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_event_.event.html b/docs/types/classes/_event_.event.html index eb2bf58656..36c42b1fac 100644 --- a/docs/types/classes/_event_.event.html +++ b/docs/types/classes/_event_.event.html @@ -2005,7 +2005,7 @@

constructor

⊕ new Event(value?: *[Uint8Array](_codec_u8a.u8a.md#uint8array)*): Event

Overrides Struct.constructor

-

Defined in Event.ts:86

+

Defined in Event.ts:86

Parameters:

@@ -2028,14 +2028,14 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


data

getdata(): EventData

-

Defined in Event.ts:144

+

Defined in Event.ts:144

description: The wrapped EventData

Returns: EventData


@@ -2043,42 +2043,42 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


index

getindex(): EventIndex

-

Defined in Event.ts:151

+

Defined in Event.ts:151

description: The EventIndex, identifying the raw event

Returns: EventIndex


meta

getmeta(): EventMetadata

-

Defined in Event.ts:158

+

Defined in Event.ts:158

description: The EventMetadata with the documentation

Returns: EventMetadata


method

getmethod(): string

-

Defined in Event.ts:165

+

Defined in Event.ts:165

description: The method string identifying the event

Returns: string


section

getsection(): string

-

Defined in Event.ts:172

+

Defined in Event.ts:172

description: The section string identifying the event

Returns: string


typeDef

gettypeDef(): Array<TypeDef>

-

Defined in Event.ts:179

+

Defined in Event.ts:179

description: The TypeDef for the event

Returns: Array<TypeDef>


@@ -2088,7 +2088,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2113,7 +2113,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2136,7 +2136,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2145,7 +2145,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2154,7 +2154,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2163,7 +2163,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2171,7 +2171,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2197,7 +2197,7 @@

<Static> decodeEvent

▸ decodeEvent(value?: Uint8Array): object | object

-

Defined in Event.ts:98

+

Defined in Event.ts:98

Parameters:

@@ -2220,7 +2220,7 @@

<Static> injectMetadata

▸ injectMetadata(metadata: Metadata): void

-

Defined in Event.ts:122

+

Defined in Event.ts:122

Parameters:

@@ -2242,7 +2242,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2305,7 +2305,7 @@ diff --git a/docs/types/classes/_event_.event.md b/docs/types/classes/_event_.event.md index 37667e9a09..7c71ac328b 100644 --- a/docs/types/classes/_event_.event.md +++ b/docs/types/classes/_event_.event.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Event.ts:86](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Event.ts#L86)* +*Defined in [Event.ts:86](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Event.ts#L86)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -64,7 +64,7 @@ ___ getdata(): [EventData](_event_.eventdata.md) -*Defined in [Event.ts:144](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Event.ts#L144)* +*Defined in [Event.ts:144](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Event.ts#L144)* *__description__*: The wrapped [EventData](_event_.eventdata.md) @@ -79,7 +79,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -92,7 +92,7 @@ ___ getindex(): [EventIndex](_event_.eventindex.md) -*Defined in [Event.ts:151](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Event.ts#L151)* +*Defined in [Event.ts:151](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Event.ts#L151)* *__description__*: The [EventIndex](_event_.eventindex.md), identifying the raw event @@ -105,7 +105,7 @@ ___ getmeta(): [EventMetadata](_metadata_events_.eventmetadata.md) -*Defined in [Event.ts:158](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Event.ts#L158)* +*Defined in [Event.ts:158](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Event.ts#L158)* *__description__*: The [EventMetadata](_metadata_events_.eventmetadata.md) with the documentation @@ -118,7 +118,7 @@ ___ getmethod(): `string` -*Defined in [Event.ts:165](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Event.ts#L165)* +*Defined in [Event.ts:165](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Event.ts#L165)* *__description__*: The method string identifying the event @@ -131,7 +131,7 @@ ___ getsection(): `string` -*Defined in [Event.ts:172](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Event.ts#L172)* +*Defined in [Event.ts:172](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Event.ts#L172)* *__description__*: The section string identifying the event @@ -144,7 +144,7 @@ ___ gettypeDef(): `Array`<[TypeDef](../modules/_types_.md#typedef)> -*Defined in [Event.ts:179](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Event.ts#L179)* +*Defined in [Event.ts:179](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Event.ts#L179)* *__description__*: The [TypeDef](../modules/_types_.md#typedef) for the event @@ -164,7 +164,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -185,7 +185,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -206,7 +206,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -223,7 +223,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -240,7 +240,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -257,7 +257,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -272,7 +272,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -291,7 +291,7 @@ ___ ▸ **decodeEvent**(value?: *`Uint8Array`*): `object` | `object` -*Defined in [Event.ts:98](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Event.ts#L98)* +*Defined in [Event.ts:98](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Event.ts#L98)* **Parameters:** @@ -308,7 +308,7 @@ ___ ▸ **injectMetadata**(metadata: *[Metadata](_metadata_index_.metadata.md)*): `void` -*Defined in [Event.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Event.ts#L122)* +*Defined in [Event.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Event.ts#L122)* **Parameters:** @@ -327,7 +327,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_event_.eventdata.html b/docs/types/classes/_event_.eventdata.html index dbcdd4bc61..a581f0211e 100644 --- a/docs/types/classes/_event_.eventdata.html +++ b/docs/types/classes/_event_.eventdata.html @@ -2002,7 +2002,7 @@

constructor

⊕ new EventData(Types: Array<Constructor>, value: Uint8Array, typeDef: Array<TypeDef>, meta: EventMetadata, section: string, method: string): EventData

Overrides Tuple.constructor

-

Defined in Event.ts:28

+

Defined in Event.ts:28

Parameters:

@@ -2045,7 +2045,7 @@

Types

getTypes(): Array<string>

Inherited from Tuple.Types

-

Defined in codec/Tuple.ts:68

+

Defined in codec/Tuple.ts:68

description: The types definition of the tuple

Returns: Array<string>


@@ -2053,35 +2053,35 @@

encodedLength

getencodedLength(): number

Inherited from Tuple.encodedLength

-

Defined in codec/Tuple.ts:59

+

Defined in codec/Tuple.ts:59

description: The length of the value when encoded as a Uint8Array

Returns: number


meta

getmeta(): EventMetadata

-

Defined in Event.ts:42

+

Defined in Event.ts:42

description: The wrapped EventMetadata

Returns: EventMetadata


method

getmethod(): string

-

Defined in Event.ts:49

+

Defined in Event.ts:49

description: The method as a string

Returns: string


section

getsection(): string

-

Defined in Event.ts:56

+

Defined in Event.ts:56

description: The section as a string

Returns: string


typeDef

gettypeDef(): Array<TypeDef>

-

Defined in Event.ts:63

+

Defined in Event.ts:63

description: The TypeDef for this event

Returns: Array<TypeDef>


@@ -2091,7 +2091,7 @@

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Inherited from Tuple.filter

Overrides Array.filter

-

Defined in codec/Tuple.ts:126

+

Defined in codec/Tuple.ts:126

description: Filters the array with the callback

Parameters:

@@ -2122,7 +2122,7 @@

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Tuple.map

Overrides Array.map

-

Defined in codec/Tuple.ts:135

+

Defined in codec/Tuple.ts:135

description: Maps the array with the callback

Type parameters:

U

@@ -2154,7 +2154,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

-

Defined in codec/Tuple.ts:77

+

Defined in codec/Tuple.ts:77

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2163,7 +2163,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

-

Defined in codec/Tuple.ts:84

+

Defined in codec/Tuple.ts:84

description: Returns a hex string representation of the value

Returns: string


@@ -2172,7 +2172,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

-

Defined in codec/Tuple.ts:91

+

Defined in codec/Tuple.ts:91

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2182,7 +2182,7 @@

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:100

+

Defined in codec/Tuple.ts:100

description: Returns the string representation of the value

Returns: string


@@ -2190,7 +2190,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Tuple.toU8a

-

Defined in codec/Tuple.ts:109

+

Defined in codec/Tuple.ts:109

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2217,7 +2217,7 @@

<Static> with

▸ with(Types: TupleConstructors): Constructor<Tuple>

Inherited from Tuple.with

-

Defined in codec/Tuple.ts:48

+

Defined in codec/Tuple.ts:48

Parameters:

@@ -2278,7 +2278,7 @@ diff --git a/docs/types/classes/_event_.eventdata.md b/docs/types/classes/_event_.eventdata.md index fbd891c0d9..cf1fa3f6bf 100644 --- a/docs/types/classes/_event_.eventdata.md +++ b/docs/types/classes/_event_.eventdata.md @@ -27,7 +27,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [Event.ts:28](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Event.ts#L28)* +*Defined in [Event.ts:28](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Event.ts#L28)* **Parameters:** @@ -54,7 +54,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -69,7 +69,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -82,7 +82,7 @@ ___ getmeta(): [EventMetadata](_metadata_events_.eventmetadata.md) -*Defined in [Event.ts:42](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Event.ts#L42)* +*Defined in [Event.ts:42](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Event.ts#L42)* *__description__*: The wrapped [EventMetadata](_metadata_events_.eventmetadata.md) @@ -95,7 +95,7 @@ ___ getmethod(): `string` -*Defined in [Event.ts:49](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Event.ts#L49)* +*Defined in [Event.ts:49](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Event.ts#L49)* *__description__*: The method as a string @@ -108,7 +108,7 @@ ___ getsection(): `string` -*Defined in [Event.ts:56](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Event.ts#L56)* +*Defined in [Event.ts:56](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Event.ts#L56)* *__description__*: The section as a string @@ -121,7 +121,7 @@ ___ gettypeDef(): `Array`<[TypeDef](../modules/_types_.md#typedef)> -*Defined in [Event.ts:63](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Event.ts#L63)* +*Defined in [Event.ts:63](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Event.ts#L63)* *__description__*: The [TypeDef](../modules/_types_.md#typedef) for this event @@ -141,7 +141,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L126)* +*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L126)* *__description__*: Filters the array with the callback @@ -165,7 +165,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L135)* +*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L135)* *__description__*: Maps the array with the callback @@ -190,7 +190,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Converts the Object to an standard JavaScript Array @@ -207,7 +207,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Returns a hex string representation of the value @@ -224,7 +224,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -243,7 +243,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L100)* +*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L100)* *__description__*: Returns the string representation of the value @@ -258,7 +258,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L109)* +*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L109)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -279,7 +279,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_event_.eventindex.html b/docs/types/classes/_event_.eventindex.html index e603f1da43..d42c89adce 100644 --- a/docs/types/classes/_event_.eventindex.html +++ b/docs/types/classes/_event_.eventindex.html @@ -2002,7 +2002,7 @@

constructor

⊕ new EventIndex(value?: any): EventIndex

Overrides U8aFixed.constructor

-

Defined in Event.ts:74

+

Defined in Event.ts:74

Parameters:

@@ -2025,7 +2025,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2034,7 +2034,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2043,7 +2043,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2052,7 +2052,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2084,7 +2084,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2093,7 +2093,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2103,7 +2103,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2111,7 +2111,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2177,7 +2177,7 @@ diff --git a/docs/types/classes/_event_.eventindex.md b/docs/types/classes/_event_.eventindex.md index 6398cd0812..d37914d95e 100644 --- a/docs/types/classes/_event_.eventindex.md +++ b/docs/types/classes/_event_.eventindex.md @@ -27,7 +27,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [Event.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Event.ts#L74)* +*Defined in [Event.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Event.ts#L74)* **Parameters:** @@ -49,7 +49,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -84,7 +84,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -101,7 +101,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -125,7 +125,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -142,7 +142,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -161,7 +161,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -176,7 +176,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_eventrecord_.applyextrinsic.html b/docs/types/classes/_eventrecord_.applyextrinsic.html index 94180ad2f9..81aec4af63 100644 --- a/docs/types/classes/_eventrecord_.applyextrinsic.html +++ b/docs/types/classes/_eventrecord_.applyextrinsic.html @@ -2001,7 +2001,7 @@

⊕ new ApplyExtrinsic(value?: AnyNumber): ApplyExtrinsic

Inherited from U32.constructor

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -2026,7 +2026,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2035,7 +2035,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2101,7 +2101,7 @@ diff --git a/docs/types/classes/_eventrecord_.applyextrinsic.md b/docs/types/classes/_eventrecord_.applyextrinsic.md index bca95abd6d..4a846b963c 100644 --- a/docs/types/classes/_eventrecord_.applyextrinsic.md +++ b/docs/types/classes/_eventrecord_.applyextrinsic.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/U32.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -69,7 +69,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_eventrecord_.eventrecord.html b/docs/types/classes/_eventrecord_.eventrecord.html index dd84eb93c9..62941b07de 100644 --- a/docs/types/classes/_eventrecord_.eventrecord.html +++ b/docs/types/classes/_eventrecord_.eventrecord.html @@ -2005,7 +2005,7 @@

constructor

⊕ new EventRecord(value: any): EventRecord

Overrides Struct.constructor

-

Defined in EventRecord.ts:47

+

Defined in EventRecord.ts:47

Parameters:

@@ -2028,7 +2028,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2036,21 +2036,21 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


event

getevent(): Event

-

Defined in EventRecord.ts:58

+

Defined in EventRecord.ts:58

description: The Event this record refers to

Returns: Event


phase

getphase(): Phase

-

Defined in EventRecord.ts:65

+

Defined in EventRecord.ts:65

description: The Phase where the event was generated

Returns: Phase


@@ -2060,7 +2060,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2085,7 +2085,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2108,7 +2108,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2117,7 +2117,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2126,7 +2126,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2135,7 +2135,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2143,7 +2143,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2170,7 +2170,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2233,7 +2233,7 @@ diff --git a/docs/types/classes/_eventrecord_.eventrecord.md b/docs/types/classes/_eventrecord_.eventrecord.md index 99419e0d71..b1b7f92932 100644 --- a/docs/types/classes/_eventrecord_.eventrecord.md +++ b/docs/types/classes/_eventrecord_.eventrecord.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [EventRecord.ts:47](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/EventRecord.ts#L47)* +*Defined in [EventRecord.ts:47](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/EventRecord.ts#L47)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -66,7 +66,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -79,7 +79,7 @@ ___ getevent(): [Event](_event_.event.md) -*Defined in [EventRecord.ts:58](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/EventRecord.ts#L58)* +*Defined in [EventRecord.ts:58](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/EventRecord.ts#L58)* *__description__*: The [Event](_event_.event.md) this record refers to @@ -92,7 +92,7 @@ ___ getphase(): [Phase](_eventrecord_.phase.md) -*Defined in [EventRecord.ts:65](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/EventRecord.ts#L65)* +*Defined in [EventRecord.ts:65](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/EventRecord.ts#L65)* *__description__*: The [Phase](_eventrecord_.phase.md) where the event was generated @@ -112,7 +112,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -133,7 +133,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -154,7 +154,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -171,7 +171,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -188,7 +188,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -205,7 +205,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -220,7 +220,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -241,7 +241,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_eventrecord_.finalization.html b/docs/types/classes/_eventrecord_.finalization.html index 66ffdf8379..20fd83f671 100644 --- a/docs/types/classes/_eventrecord_.finalization.html +++ b/docs/types/classes/_eventrecord_.finalization.html @@ -2000,7 +2000,7 @@

encodedLength

getencodedLength(): number

Inherited from Null.encodedLength

-

Defined in Null.ts:16

+

Defined in Null.ts:16

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2010,7 +2010,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Null.toHex

-

Defined in Null.ts:23

+

Defined in Null.ts:23

description: Returns a hex string representation of the value

Returns: string


@@ -2019,7 +2019,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Null.toJSON

-

Defined in Null.ts:30

+

Defined in Null.ts:30

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2028,7 +2028,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Null.toString

-

Defined in Null.ts:37

+

Defined in Null.ts:37

description: Returns the string representation of the value

Returns: string


@@ -2036,7 +2036,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Null.toU8a

-

Defined in Null.ts:45

+

Defined in Null.ts:45

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2102,7 +2102,7 @@ diff --git a/docs/types/classes/_eventrecord_.finalization.md b/docs/types/classes/_eventrecord_.finalization.md index 8bdfa54172..e6492e7f27 100644 --- a/docs/types/classes/_eventrecord_.finalization.md +++ b/docs/types/classes/_eventrecord_.finalization.md @@ -24,7 +24,7 @@ getencodedLength(): `number` *Inherited from [Null](_null_.null.md).[encodedLength](_null_.null.md#encodedlength)* -*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L16)* +*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L16)* *__description__*: The length of the value when encoded as a Uint8Array @@ -44,7 +44,7 @@ ___ *Inherited from [Null](_null_.null.md).[toHex](_null_.null.md#tohex)* -*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L23)* +*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L23)* *__description__*: Returns a hex string representation of the value @@ -61,7 +61,7 @@ ___ *Inherited from [Null](_null_.null.md).[toJSON](_null_.null.md#tojson)* -*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L30)* +*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L30)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -78,7 +78,7 @@ ___ *Inherited from [Null](_null_.null.md).[toString](_null_.null.md#tostring)* -*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L37)* +*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L37)* *__description__*: Returns the string representation of the value @@ -93,7 +93,7 @@ ___ *Inherited from [Null](_null_.null.md).[toU8a](_null_.null.md#tou8a)* -*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L45)* +*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L45)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_eventrecord_.phase.html b/docs/types/classes/_eventrecord_.phase.html index 570b68a416..856060c4c8 100644 --- a/docs/types/classes/_eventrecord_.phase.html +++ b/docs/types/classes/_eventrecord_.phase.html @@ -2000,7 +2000,7 @@

constructor

⊕ new Phase(value: any, index?: undefined | number): Phase

Overrides EnumType.constructor

-

Defined in EventRecord.ts:32

+

Defined in EventRecord.ts:32

Parameters:

@@ -2028,7 +2028,7 @@

encodedLength

getencodedLength(): number

Inherited from EnumType.encodedLength

-

Defined in codec/EnumType.ts:97

+

Defined in codec/EnumType.ts:97

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2036,7 +2036,7 @@

isNone

getisNone(): boolean

Inherited from EnumType.isNone

-

Defined in codec/EnumType.ts:104

+

Defined in codec/EnumType.ts:104

description: Checks if the Enum points to a Null type

Returns: boolean


@@ -2044,7 +2044,7 @@

isNull

getisNull(): boolean

Inherited from EnumType.isNull

-

Defined in codec/EnumType.ts:111

+

Defined in codec/EnumType.ts:111

description: Checks if the Enum points to a Null type (deprecated, use isNone)

Returns: boolean


@@ -2052,7 +2052,7 @@

type

gettype(): string

Inherited from EnumType.type

-

Defined in codec/EnumType.ts:118

+

Defined in codec/EnumType.ts:118

description: The name of the type this enum value represents

Returns: string


@@ -2060,7 +2060,7 @@

value

getvalue(): Codec

Inherited from EnumType.value

-

Defined in codec/EnumType.ts:125

+

Defined in codec/EnumType.ts:125

description: The value of the enum

Returns: Codec


@@ -2070,7 +2070,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from EnumType.toHex

-

Defined in codec/EnumType.ts:132

+

Defined in codec/EnumType.ts:132

description: Returns a hex string representation of the value

Returns: string


@@ -2079,7 +2079,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from EnumType.toJSON

-

Defined in codec/EnumType.ts:139

+

Defined in codec/EnumType.ts:139

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2087,7 +2087,7 @@

toNumber

▸ toNumber(): number

Inherited from EnumType.toNumber

-

Defined in codec/EnumType.ts:146

+

Defined in codec/EnumType.ts:146

description: Returns the number representation for the value

Returns: number


@@ -2096,7 +2096,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from EnumType.toString

-

Defined in codec/EnumType.ts:153

+

Defined in codec/EnumType.ts:153

description: Returns the string representation of the value

Returns: string


@@ -2104,7 +2104,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from EnumType.toU8a

-

Defined in codec/EnumType.ts:161

+

Defined in codec/EnumType.ts:161

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2170,7 +2170,7 @@ diff --git a/docs/types/classes/_eventrecord_.phase.md b/docs/types/classes/_eventrecord_.phase.md index 9a82862d12..bb7728e3c4 100644 --- a/docs/types/classes/_eventrecord_.phase.md +++ b/docs/types/classes/_eventrecord_.phase.md @@ -24,7 +24,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [EventRecord.ts:32](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/EventRecord.ts#L32)* +*Defined in [EventRecord.ts:32](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/EventRecord.ts#L32)* **Parameters:** @@ -47,7 +47,7 @@ getencodedLength(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* -*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L97)* +*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L97)* *__description__*: The length of the value when encoded as a Uint8Array @@ -62,7 +62,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L104)* +*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L104)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type @@ -77,7 +77,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L111)* +*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L111)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone) @@ -92,7 +92,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L118)* +*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L118)* *__description__*: The name of the type this enum value represents @@ -107,7 +107,7 @@ getvalue(): [Codec](../interfaces/_types_.codec.md) *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L125)* +*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L125)* *__description__*: The value of the enum @@ -127,7 +127,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L132)* +*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L132)* *__description__*: Returns a hex string representation of the value @@ -144,7 +144,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L139)* +*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L139)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -159,7 +159,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L146)* +*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L146)* *__description__*: Returns the number representation for the value @@ -176,7 +176,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [codec/EnumType.ts:153](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L153)* +*Defined in [codec/EnumType.ts:153](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L153)* *__description__*: Returns the string representation of the value @@ -191,7 +191,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L161)* +*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L161)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_extrinsic_.extrinsic.html b/docs/types/classes/_extrinsic_.extrinsic.html index 0a7fad26c6..47b4ad73b8 100644 --- a/docs/types/classes/_extrinsic_.extrinsic.html +++ b/docs/types/classes/_extrinsic_.extrinsic.html @@ -2011,7 +2011,7 @@

constructor

⊕ new Extrinsic(value?: ExtrinsicValue | AnyU8a | Method): Extrinsic

Overrides Struct.constructor

-

Defined in Extrinsic.ts:36

+

Defined in Extrinsic.ts:36

Parameters:

@@ -2036,28 +2036,28 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


args

getargs(): Array<Codec>

-

Defined in Extrinsic.ts:71

+

Defined in Extrinsic.ts:71

description: The arguments passed to for the call, exposes args so it is compatible with Method

Returns: Array<Codec>


callIndex

getcallIndex(): Uint8Array

-

Defined in Extrinsic.ts:78

+

Defined in Extrinsic.ts:78

description: The actual [sectionIndex, methodIndex] as used in the Method

Returns: Uint8Array


data

getdata(): Uint8Array

-

Defined in Extrinsic.ts:85

+

Defined in Extrinsic.ts:85

description: The actual data for the Method

Returns: Uint8Array


@@ -2065,49 +2065,49 @@

encodedLength

getencodedLength(): number

Overrides Struct.encodedLength

-

Defined in Extrinsic.ts:92

+

Defined in Extrinsic.ts:92

description: The length of the value when encoded as a Uint8Array

Returns: number


hash

gethash(): Hash

-

Defined in Extrinsic.ts:101

+

Defined in Extrinsic.ts:101

description: Convernience function, encodes the extrinsic and returns the actual hash

Returns: Hash


isSigned

getisSigned(): boolean

-

Defined in Extrinsic.ts:110

+

Defined in Extrinsic.ts:110

description: true id the extrinsic is signed

Returns: boolean


length

getlength(): number

-

Defined in Extrinsic.ts:117

+

Defined in Extrinsic.ts:117

description: The length of the encoded value

Returns: number


meta

getmeta(): FunctionMetadata

-

Defined in Extrinsic.ts:124

+

Defined in Extrinsic.ts:124

description: The FunctionMetadata that describes the extrinsic

Returns: FunctionMetadata


method

getmethod(): Method

-

Defined in Extrinsic.ts:131

+

Defined in Extrinsic.ts:131

description: The Method this extrinsic wraps

Returns: Method


signature

getsignature(): ExtrinsicSignature

-

Defined in Extrinsic.ts:138

+

Defined in Extrinsic.ts:138

description: The ExtrinsicSignature

Returns: ExtrinsicSignature


@@ -2115,7 +2115,7 @@

addSignature

▸ addSignature(signer: Address | Uint8Array, signature: Uint8Array, nonce: AnyNumber, era?: Uint8Array): Extrinsic

-

Defined in Extrinsic.ts:145

+

Defined in Extrinsic.ts:145

description: Add an ExtrinsicSignature to the extrinsic (already generated)

Parameters:

@@ -2152,7 +2152,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2177,7 +2177,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2199,7 +2199,7 @@

sign

▸ sign(signerPair: KeyringPair, nonce: AnyNumber, blockHash: AnyU8a, era?: Uint8Array): Extrinsic

-

Defined in Extrinsic.ts:154

+

Defined in Extrinsic.ts:154

description: Sign the extrinsic with a specific keypair

Parameters:

@@ -2234,7 +2234,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2243,7 +2243,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Overrides Struct.toHex

-

Defined in Extrinsic.ts:163

+

Defined in Extrinsic.ts:163

description: Returns a hex string representation of the value

Returns: string


@@ -2252,7 +2252,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Overrides Struct.toJSON

-

Defined in Extrinsic.ts:170

+

Defined in Extrinsic.ts:170

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2261,7 +2261,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2269,7 +2269,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Overrides Struct.toU8a

-

Defined in Extrinsic.ts:178

+

Defined in Extrinsic.ts:178

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2295,7 +2295,7 @@

<Static> decodeExtrinsic

▸ decodeExtrinsic(value: ExtrinsicValue | AnyU8a | Method): ExtrinsicValue | Array<number> | Uint8Array

-

Defined in Extrinsic.ts:44

+

Defined in Extrinsic.ts:44

Parameters:

@@ -2319,7 +2319,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2382,7 +2382,7 @@ diff --git a/docs/types/classes/_extrinsic_.extrinsic.md b/docs/types/classes/_extrinsic_.extrinsic.md index aede0b24bb..e05d9891fc 100644 --- a/docs/types/classes/_extrinsic_.extrinsic.md +++ b/docs/types/classes/_extrinsic_.extrinsic.md @@ -36,7 +36,7 @@ Can be: *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Extrinsic.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L36)* +*Defined in [Extrinsic.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L36)* **Parameters:** @@ -58,7 +58,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -71,7 +71,7 @@ ___ getargs(): `Array`<[Codec](../interfaces/_types_.codec.md)> -*Defined in [Extrinsic.ts:71](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L71)* +*Defined in [Extrinsic.ts:71](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L71)* *__description__*: The arguments passed to for the call, exposes args so it is compatible with [Method](_method_.method.md) @@ -84,7 +84,7 @@ ___ getcallIndex(): `Uint8Array` -*Defined in [Extrinsic.ts:78](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L78)* +*Defined in [Extrinsic.ts:78](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L78)* *__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method @@ -97,7 +97,7 @@ ___ getdata(): `Uint8Array` -*Defined in [Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L85)* +*Defined in [Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L85)* *__description__*: The actual data for the Method @@ -112,7 +112,7 @@ getencodedLength(): `number` *Overrides [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [Extrinsic.ts:92](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L92)* +*Defined in [Extrinsic.ts:92](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L92)* *__description__*: The length of the value when encoded as a Uint8Array @@ -125,7 +125,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L101)* +*Defined in [Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L101)* *__description__*: Convernience function, encodes the extrinsic and returns the actual hash @@ -138,7 +138,7 @@ ___ getisSigned(): `boolean` -*Defined in [Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L110)* +*Defined in [Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L110)* *__description__*: `true` id the extrinsic is signed @@ -151,7 +151,7 @@ ___ getlength(): `number` -*Defined in [Extrinsic.ts:117](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L117)* +*Defined in [Extrinsic.ts:117](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L117)* *__description__*: The length of the encoded value @@ -164,7 +164,7 @@ ___ getmeta(): [FunctionMetadata](_metadata_modules_.functionmetadata.md) -*Defined in [Extrinsic.ts:124](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L124)* +*Defined in [Extrinsic.ts:124](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L124)* *__description__*: The [FunctionMetadata](_metadata_modules_.functionmetadata.md) that describes the extrinsic @@ -177,7 +177,7 @@ ___ getmethod(): [Method](_method_.method.md) -*Defined in [Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L131)* +*Defined in [Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L131)* *__description__*: The [Method](_method_.method.md) this extrinsic wraps @@ -190,7 +190,7 @@ ___ getsignature(): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) -*Defined in [Extrinsic.ts:138](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L138)* +*Defined in [Extrinsic.ts:138](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L138)* *__description__*: The [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) @@ -206,7 +206,7 @@ ___ ▸ **addSignature**(signer: *[Address](_address_.address.md) | `Uint8Array`*, signature: *`Uint8Array`*, nonce: *[AnyNumber](../modules/_types_.md#anynumber)*, era?: *[Uint8Array](_codec_u8a_.u8a.md#uint8array)*): [Extrinsic](_extrinsic_.extrinsic.md) -*Defined in [Extrinsic.ts:145](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L145)* +*Defined in [Extrinsic.ts:145](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L145)* *__description__*: Add an [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) to the extrinsic (already generated) @@ -232,7 +232,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -253,7 +253,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -272,7 +272,7 @@ ___ ▸ **sign**(signerPair: *`KeyringPair`*, nonce: *[AnyNumber](../modules/_types_.md#anynumber)*, blockHash: *[AnyU8a](../modules/_types_.md#anyu8a)*, era?: *[Uint8Array](_codec_u8a_.u8a.md#uint8array)*): [Extrinsic](_extrinsic_.extrinsic.md) -*Defined in [Extrinsic.ts:154](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L154)* +*Defined in [Extrinsic.ts:154](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L154)* *__description__*: Sign the extrinsic with a specific keypair @@ -296,7 +296,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -313,7 +313,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [Extrinsic.ts:163](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L163)* +*Defined in [Extrinsic.ts:163](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L163)* *__description__*: Returns a hex string representation of the value @@ -330,7 +330,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [Extrinsic.ts:170](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L170)* +*Defined in [Extrinsic.ts:170](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L170)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -362,7 +362,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [Extrinsic.ts:178](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L178)* +*Defined in [Extrinsic.ts:178](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L178)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -381,7 +381,7 @@ ___ ▸ **decodeExtrinsic**(value: *`ExtrinsicValue` | [AnyU8a](../modules/_types_.md#anyu8a) | [Method](_method_.method.md)*): `ExtrinsicValue` | `Array`<`number`> | `Uint8Array` -*Defined in [Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Extrinsic.ts#L44)* +*Defined in [Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Extrinsic.ts#L44)* **Parameters:** @@ -400,7 +400,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_extrinsicera_.extrinsicera.html b/docs/types/classes/_extrinsicera_.extrinsicera.html index 62e304d37c..76e9e9f7bd 100644 --- a/docs/types/classes/_extrinsicera_.extrinsicera.html +++ b/docs/types/classes/_extrinsicera_.extrinsicera.html @@ -2002,7 +2002,7 @@

constructor

⊕ new ExtrinsicEra(value?: AnyU8a): ExtrinsicEra

Overrides U8a.constructor

-

Defined in ExtrinsicEra.ts:16

+

Defined in ExtrinsicEra.ts:16

Parameters:

@@ -2025,7 +2025,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2034,7 +2034,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2044,7 +2044,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2076,7 +2076,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2085,7 +2085,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2095,7 +2095,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2103,7 +2103,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2129,7 +2129,7 @@

<Static> decodeExtrinsicEra

▸ decodeExtrinsicEra(value?: AnyU8a): Uint8Array

-

Defined in ExtrinsicEra.ts:23

+

Defined in ExtrinsicEra.ts:23

Parameters:

@@ -2190,7 +2190,7 @@ diff --git a/docs/types/classes/_extrinsicera_.extrinsicera.md b/docs/types/classes/_extrinsicera_.extrinsicera.md index f9daa7557d..21a9d760ac 100644 --- a/docs/types/classes/_extrinsicera_.extrinsicera.md +++ b/docs/types/classes/_extrinsicera_.extrinsicera.md @@ -27,7 +27,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [ExtrinsicEra.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ExtrinsicEra.ts#L16)* +*Defined in [ExtrinsicEra.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ExtrinsicEra.ts#L16)* **Parameters:** @@ -49,7 +49,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -86,7 +86,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -110,7 +110,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -127,7 +127,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -146,7 +146,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -161,7 +161,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -180,7 +180,7 @@ ___ ▸ **decodeExtrinsicEra**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): `Uint8Array` -*Defined in [ExtrinsicEra.ts:23](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ExtrinsicEra.ts#L23)* +*Defined in [ExtrinsicEra.ts:23](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ExtrinsicEra.ts#L23)* **Parameters:** diff --git a/docs/types/classes/_extrinsics_.extrinsics.html b/docs/types/classes/_extrinsics_.extrinsics.html index a113eab5e7..6c5a12fc44 100644 --- a/docs/types/classes/_extrinsics_.extrinsics.html +++ b/docs/types/classes/_extrinsics_.extrinsics.html @@ -2005,7 +2005,7 @@

constructor

⊕ new Extrinsics(Type: Constructor<T>, value?: Vector<any> | Uint8Array | string | Array<any>): Extrinsics

Inherited from Vector.constructor

-

Defined in codec/Vector.ts:22

+

Defined in codec/Vector.ts:22

Parameters:

@@ -2038,14 +2038,14 @@

Type

getType(): string

Inherited from Vector.Type

-

Defined in codec/Vector.ts:57

+

Defined in codec/Vector.ts:57

Returns: string


encodedLength

getencodedLength(): number

Inherited from Vector.encodedLength

-

Defined in codec/Vector.ts:64

+

Defined in codec/Vector.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2054,7 +2054,7 @@

getlength(): number

Inherited from Vector.length

Overrides Array.length

-

Defined in codec/Vector.ts:73

+

Defined in codec/Vector.ts:73

description: The length of the value

Returns: number


@@ -2064,7 +2064,7 @@

▸ filter(callbackfn: function, thisArg?: any): Array<T>

Inherited from Vector.filter

Overrides Array.filter

-

Defined in codec/Vector.ts:139

+

Defined in codec/Vector.ts:139

description: Filters the array with the callback

Parameters:

@@ -2095,7 +2095,7 @@

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Vector.map

Overrides Array.map

-

Defined in codec/Vector.ts:148

+

Defined in codec/Vector.ts:148

description: Maps the array with the callback

Type parameters:

U

@@ -2127,7 +2127,7 @@

toArray

▸ toArray(): Array<T>

Inherited from Vector.toArray

-

Defined in codec/Vector.ts:81

+

Defined in codec/Vector.ts:81

description: Converts the Object to an standard JavaScript Array

Returns: Array<T>


@@ -2136,7 +2136,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Vector.toHex

-

Defined in codec/Vector.ts:88

+

Defined in codec/Vector.ts:88

description: Returns a hex string representation of the value

Returns: string


@@ -2145,7 +2145,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Vector.toJSON

-

Defined in codec/Vector.ts:95

+

Defined in codec/Vector.ts:95

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2155,7 +2155,7 @@

Implementation of Codec.toString

Inherited from Vector.toString

Overrides Array.toString

-

Defined in codec/Vector.ts:104

+

Defined in codec/Vector.ts:104

description: Returns the string representation of the value

Returns: string


@@ -2163,7 +2163,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Vector.toU8a

-

Defined in codec/Vector.ts:117

+

Defined in codec/Vector.ts:117

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2190,7 +2190,7 @@

<Static> decodeVector

▸ decodeVector<T>(Type: Constructor<T>, value: Vector<any> | Uint8Array | string | Array<any>): Array<T>

Inherited from Vector.decodeVector

-

Defined in codec/Vector.ts:32

+

Defined in codec/Vector.ts:32

Type parameters:

T : Codec

Parameters:

@@ -2221,7 +2221,7 @@

<Static> with

▸ with<O>(Type: Constructor<O>): Constructor<Vector<O>>

Inherited from Vector.with

-

Defined in codec/Vector.ts:49

+

Defined in codec/Vector.ts:49

Type parameters:

O : Codec

Parameters:

@@ -2284,7 +2284,7 @@ diff --git a/docs/types/classes/_extrinsics_.extrinsics.md b/docs/types/classes/_extrinsics_.extrinsics.md index 08bfa0e7c5..9150a87ced 100644 --- a/docs/types/classes/_extrinsics_.extrinsics.md +++ b/docs/types/classes/_extrinsics_.extrinsics.md @@ -31,7 +31,7 @@ *Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)* -*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L22)* +*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L22)* **Parameters:** @@ -54,7 +54,7 @@ getType(): `string` *Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* -*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L57)* +*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L57)* **Returns:** `string` @@ -67,7 +67,7 @@ getencodedLength(): `number` *Inherited from [Vector](_codec_vector_.vector.md).[encodedLength](_codec_vector_.vector.md#encodedlength)* -*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L64)* +*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -84,7 +84,7 @@ getlength(): `number` *Overrides Array.length* -*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L73)* +*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L73)* *__description__*: The length of the value @@ -104,7 +104,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L139)* +*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L139)* *__description__*: Filters the array with the callback @@ -128,7 +128,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L148)* +*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L148)* *__description__*: Maps the array with the callback @@ -153,7 +153,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)* -*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L81)* +*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L81)* *__description__*: Converts the Object to an standard JavaScript Array @@ -170,7 +170,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)* -*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L88)* +*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L88)* *__description__*: Returns a hex string representation of the value @@ -187,7 +187,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* -*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L95)* +*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L95)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -206,7 +206,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L104)* +*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L104)* *__description__*: Returns the string representation of the value @@ -221,7 +221,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* -*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L117)* +*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L117)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -242,7 +242,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[decodeVector](_codec_vector_.vector.md#decodevector)* -*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L32)* +*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L32)* **Type parameters:** @@ -265,7 +265,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* -*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L49)* +*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L49)* **Type parameters:** diff --git a/docs/types/classes/_extrinsicsignature_.extrinsicsignature.html b/docs/types/classes/_extrinsicsignature_.extrinsicsignature.html index 78921dbe0f..aabc4f7dae 100644 --- a/docs/types/classes/_extrinsicsignature_.extrinsicsignature.html +++ b/docs/types/classes/_extrinsicsignature_.extrinsicsignature.html @@ -2005,7 +2005,7 @@

constructor

⊕ new ExtrinsicSignature(value?: ExtrinsicSignatureValue | Uint8Array): ExtrinsicSignature

Overrides Struct.constructor

-

Defined in ExtrinsicSignature.ts:37

+

Defined in ExtrinsicSignature.ts:37

Parameters:

@@ -2029,7 +2029,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2037,49 +2037,49 @@

encodedLength

getencodedLength(): number

Overrides Struct.encodedLength

-

Defined in ExtrinsicSignature.ts:71

+

Defined in ExtrinsicSignature.ts:71

description: The length of the value when encoded as a Uint8Array

Returns: number


era

getera(): ExtrinsicEra

-

Defined in ExtrinsicSignature.ts:90

+

Defined in ExtrinsicSignature.ts:90

description: The ExtrinsicEra (mortal or immortal) this signature applies to

Returns: ExtrinsicEra


isSigned

getisSigned(): boolean

-

Defined in ExtrinsicSignature.ts:83

+

Defined in ExtrinsicSignature.ts:83

description: true if the signature is valid

Returns: boolean


nonce

getnonce(): Nonce

-

Defined in ExtrinsicSignature.ts:97

+

Defined in ExtrinsicSignature.ts:97

description: The Nonce for the signature

Returns: Nonce


signature

getsignature(): Signature

-

Defined in ExtrinsicSignature.ts:104

+

Defined in ExtrinsicSignature.ts:104

description: The actuall Signature hash

Returns: Signature


signer

getsigner(): Address

-

Defined in ExtrinsicSignature.ts:111

+

Defined in ExtrinsicSignature.ts:111

description: The Address that signed

Returns: Address


version

getversion(): number

-

Defined in ExtrinsicSignature.ts:118

+

Defined in ExtrinsicSignature.ts:118

description: The encoded version for the signature

Returns: number


@@ -2087,7 +2087,7 @@

addSignature

▸ addSignature(signer: *[Address](_address.address.md) | Uint8Array, _signature: Uint8Array, _nonce: AnyNumber, _era?: Uint8Array*): ExtrinsicSignature

-

Defined in ExtrinsicSignature.ts:142

+

Defined in ExtrinsicSignature.ts:142

description: Adds a raw signature

Parameters:

@@ -2129,7 +2129,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2154,7 +2154,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2176,7 +2176,7 @@

sign

▸ sign(method: Method, signerPair: KeyringPair, nonce: AnyNumber, blockHash: AnyU8a, era?: Uint8Array): ExtrinsicSignature

-

Defined in ExtrinsicSignature.ts:154

+

Defined in ExtrinsicSignature.ts:154

description: Generate a payload and pplies the signature from a keypair

Parameters:

@@ -2221,7 +2221,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2230,7 +2230,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2239,7 +2239,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2248,7 +2248,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2256,7 +2256,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Overrides Struct.toU8a

-

Defined in ExtrinsicSignature.ts:171

+

Defined in ExtrinsicSignature.ts:171

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2282,7 +2282,7 @@

<Static> decodeExtrinsicSignature

▸ decodeExtrinsicSignature(value: ExtrinsicSignature | ExtrinsicSignatureValue | AnyU8a | undefined): object | Uint8Array

-

Defined in ExtrinsicSignature.ts:52

+

Defined in ExtrinsicSignature.ts:52

Parameters:

@@ -2307,7 +2307,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2370,7 +2370,7 @@ diff --git a/docs/types/classes/_extrinsicsignature_.extrinsicsignature.md b/docs/types/classes/_extrinsicsignature_.extrinsicsignature.md index 5f72a2d226..6588656c0a 100644 --- a/docs/types/classes/_extrinsicsignature_.extrinsicsignature.md +++ b/docs/types/classes/_extrinsicsignature_.extrinsicsignature.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [ExtrinsicSignature.ts:37](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ExtrinsicSignature.ts#L37)* +*Defined in [ExtrinsicSignature.ts:37](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ExtrinsicSignature.ts#L37)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -66,7 +66,7 @@ getencodedLength(): `number` *Overrides [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [ExtrinsicSignature.ts:71](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ExtrinsicSignature.ts#L71)* +*Defined in [ExtrinsicSignature.ts:71](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ExtrinsicSignature.ts#L71)* *__description__*: The length of the value when encoded as a Uint8Array @@ -79,7 +79,7 @@ ___ getera(): [ExtrinsicEra](_extrinsicera_.extrinsicera.md) -*Defined in [ExtrinsicSignature.ts:90](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ExtrinsicSignature.ts#L90)* +*Defined in [ExtrinsicSignature.ts:90](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ExtrinsicSignature.ts#L90)* *__description__*: The [ExtrinsicEra](_extrinsicera_.extrinsicera.md) (mortal or immortal) this signature applies to @@ -92,7 +92,7 @@ ___ getisSigned(): `boolean` -*Defined in [ExtrinsicSignature.ts:83](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ExtrinsicSignature.ts#L83)* +*Defined in [ExtrinsicSignature.ts:83](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ExtrinsicSignature.ts#L83)* *__description__*: `true` if the signature is valid @@ -105,7 +105,7 @@ ___ getnonce(): [Nonce](_nonce_.nonce.md) -*Defined in [ExtrinsicSignature.ts:97](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ExtrinsicSignature.ts#L97)* +*Defined in [ExtrinsicSignature.ts:97](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ExtrinsicSignature.ts#L97)* *__description__*: The [Nonce](_nonce_.nonce.md) for the signature @@ -118,7 +118,7 @@ ___ getsignature(): [Signature](_signature_.signature.md) -*Defined in [ExtrinsicSignature.ts:104](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ExtrinsicSignature.ts#L104)* +*Defined in [ExtrinsicSignature.ts:104](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ExtrinsicSignature.ts#L104)* *__description__*: The actuall [Signature](_signature_.signature.md) hash @@ -131,7 +131,7 @@ ___ getsigner(): [Address](_address_.address.md) -*Defined in [ExtrinsicSignature.ts:111](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ExtrinsicSignature.ts#L111)* +*Defined in [ExtrinsicSignature.ts:111](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ExtrinsicSignature.ts#L111)* *__description__*: The [Address](_address_.address.md) that signed @@ -144,7 +144,7 @@ ___ getversion(): `number` -*Defined in [ExtrinsicSignature.ts:118](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ExtrinsicSignature.ts#L118)* +*Defined in [ExtrinsicSignature.ts:118](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ExtrinsicSignature.ts#L118)* *__description__*: The encoded version for the signature @@ -160,7 +160,7 @@ ___ ▸ **addSignature**(_signer: *[Address](_address_.address.md) | `Uint8Array`*, _signature: *`Uint8Array`*, _nonce: *[AnyNumber](../modules/_types_.md#anynumber)*, _era?: *`Uint8Array`*): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) -*Defined in [ExtrinsicSignature.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ExtrinsicSignature.ts#L142)* +*Defined in [ExtrinsicSignature.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ExtrinsicSignature.ts#L142)* *__description__*: Adds a raw signature @@ -186,7 +186,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -207,7 +207,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -226,7 +226,7 @@ ___ ▸ **sign**(method: *[Method](_method_.method.md)*, signerPair: *`KeyringPair`*, nonce: *[AnyNumber](../modules/_types_.md#anynumber)*, blockHash: *[AnyU8a](../modules/_types_.md#anyu8a)*, era?: *`Uint8Array`*): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) -*Defined in [ExtrinsicSignature.ts:154](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ExtrinsicSignature.ts#L154)* +*Defined in [ExtrinsicSignature.ts:154](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ExtrinsicSignature.ts#L154)* *__description__*: Generate a payload and pplies the signature from a keypair @@ -251,7 +251,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -268,7 +268,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -285,7 +285,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -302,7 +302,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -317,7 +317,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [ExtrinsicSignature.ts:171](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ExtrinsicSignature.ts#L171)* +*Defined in [ExtrinsicSignature.ts:171](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ExtrinsicSignature.ts#L171)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -336,7 +336,7 @@ ___ ▸ **decodeExtrinsicSignature**(value: *[ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) | `ExtrinsicSignatureValue` | [AnyU8a](../modules/_types_.md#anyu8a) | `undefined`*): `object` | `Uint8Array` -*Defined in [ExtrinsicSignature.ts:52](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ExtrinsicSignature.ts#L52)* +*Defined in [ExtrinsicSignature.ts:52](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ExtrinsicSignature.ts#L52)* **Parameters:** @@ -355,7 +355,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_extrinsicstatus_.broadcast.html b/docs/types/classes/_extrinsicstatus_.broadcast.html index 8d496482b4..74f3f9fe87 100644 --- a/docs/types/classes/_extrinsicstatus_.broadcast.html +++ b/docs/types/classes/_extrinsicstatus_.broadcast.html @@ -2004,7 +2004,7 @@

constructor

⊕ new Broadcast(Type: Constructor<T>, value?: Vector<any> | Uint8Array | string | Array<any>): Broadcast

Inherited from Vector.constructor

-

Defined in codec/Vector.ts:22

+

Defined in codec/Vector.ts:22

Parameters:

@@ -2037,14 +2037,14 @@

Type

getType(): string

Inherited from Vector.Type

-

Defined in codec/Vector.ts:57

+

Defined in codec/Vector.ts:57

Returns: string


encodedLength

getencodedLength(): number

Inherited from Vector.encodedLength

-

Defined in codec/Vector.ts:64

+

Defined in codec/Vector.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2053,7 +2053,7 @@

getlength(): number

Inherited from Vector.length

Overrides Array.length

-

Defined in codec/Vector.ts:73

+

Defined in codec/Vector.ts:73

description: The length of the value

Returns: number


@@ -2063,7 +2063,7 @@

▸ filter(callbackfn: function, thisArg?: any): Array<T>

Inherited from Vector.filter

Overrides Array.filter

-

Defined in codec/Vector.ts:139

+

Defined in codec/Vector.ts:139

description: Filters the array with the callback

Parameters:

@@ -2094,7 +2094,7 @@

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Vector.map

Overrides Array.map

-

Defined in codec/Vector.ts:148

+

Defined in codec/Vector.ts:148

description: Maps the array with the callback

Type parameters:

U

@@ -2126,7 +2126,7 @@

toArray

▸ toArray(): Array<T>

Inherited from Vector.toArray

-

Defined in codec/Vector.ts:81

+

Defined in codec/Vector.ts:81

description: Converts the Object to an standard JavaScript Array

Returns: Array<T>


@@ -2135,7 +2135,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Vector.toHex

-

Defined in codec/Vector.ts:88

+

Defined in codec/Vector.ts:88

description: Returns a hex string representation of the value

Returns: string


@@ -2144,7 +2144,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Vector.toJSON

-

Defined in codec/Vector.ts:95

+

Defined in codec/Vector.ts:95

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2154,7 +2154,7 @@

Implementation of Codec.toString

Inherited from Vector.toString

Overrides Array.toString

-

Defined in codec/Vector.ts:104

+

Defined in codec/Vector.ts:104

description: Returns the string representation of the value

Returns: string


@@ -2162,7 +2162,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Vector.toU8a

-

Defined in codec/Vector.ts:117

+

Defined in codec/Vector.ts:117

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2189,7 +2189,7 @@

<Static> decodeVector

▸ decodeVector<T>(Type: Constructor<T>, value: Vector<any> | Uint8Array | string | Array<any>): Array<T>

Inherited from Vector.decodeVector

-

Defined in codec/Vector.ts:32

+

Defined in codec/Vector.ts:32

Type parameters:

T : Codec

Parameters:

@@ -2220,7 +2220,7 @@

<Static> with

▸ with<O>(Type: Constructor<O>): Constructor<Vector<O>>

Inherited from Vector.with

-

Defined in codec/Vector.ts:49

+

Defined in codec/Vector.ts:49

Type parameters:

O : Codec

Parameters:

@@ -2283,7 +2283,7 @@ diff --git a/docs/types/classes/_extrinsicstatus_.broadcast.md b/docs/types/classes/_extrinsicstatus_.broadcast.md index f1acd02af1..86158c5eca 100644 --- a/docs/types/classes/_extrinsicstatus_.broadcast.md +++ b/docs/types/classes/_extrinsicstatus_.broadcast.md @@ -29,7 +29,7 @@ *Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)* -*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L22)* +*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L22)* **Parameters:** @@ -52,7 +52,7 @@ getType(): `string` *Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* -*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L57)* +*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L57)* **Returns:** `string` @@ -65,7 +65,7 @@ getencodedLength(): `number` *Inherited from [Vector](_codec_vector_.vector.md).[encodedLength](_codec_vector_.vector.md#encodedlength)* -*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L64)* +*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -82,7 +82,7 @@ getlength(): `number` *Overrides Array.length* -*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L73)* +*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L73)* *__description__*: The length of the value @@ -102,7 +102,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L139)* +*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L139)* *__description__*: Filters the array with the callback @@ -126,7 +126,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L148)* +*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L148)* *__description__*: Maps the array with the callback @@ -151,7 +151,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)* -*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L81)* +*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L81)* *__description__*: Converts the Object to an standard JavaScript Array @@ -168,7 +168,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)* -*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L88)* +*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L88)* *__description__*: Returns a hex string representation of the value @@ -185,7 +185,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* -*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L95)* +*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L95)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -204,7 +204,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L104)* +*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L104)* *__description__*: Returns the string representation of the value @@ -219,7 +219,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* -*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L117)* +*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L117)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -240,7 +240,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[decodeVector](_codec_vector_.vector.md#decodevector)* -*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L32)* +*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L32)* **Type parameters:** @@ -263,7 +263,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* -*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L49)* +*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L49)* **Type parameters:** diff --git a/docs/types/classes/_extrinsicstatus_.dropped.html b/docs/types/classes/_extrinsicstatus_.dropped.html index 3721bb34bc..d4ca59bdce 100644 --- a/docs/types/classes/_extrinsicstatus_.dropped.html +++ b/docs/types/classes/_extrinsicstatus_.dropped.html @@ -2000,7 +2000,7 @@

encodedLength

getencodedLength(): number

Inherited from Null.encodedLength

-

Defined in Null.ts:16

+

Defined in Null.ts:16

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2010,7 +2010,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Null.toHex

-

Defined in Null.ts:23

+

Defined in Null.ts:23

description: Returns a hex string representation of the value

Returns: string


@@ -2019,7 +2019,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Null.toJSON

-

Defined in Null.ts:30

+

Defined in Null.ts:30

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2028,7 +2028,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Null.toString

-

Defined in Null.ts:37

+

Defined in Null.ts:37

description: Returns the string representation of the value

Returns: string


@@ -2036,7 +2036,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Null.toU8a

-

Defined in Null.ts:45

+

Defined in Null.ts:45

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2102,7 +2102,7 @@ diff --git a/docs/types/classes/_extrinsicstatus_.dropped.md b/docs/types/classes/_extrinsicstatus_.dropped.md index 6fd4a76392..639df30ab8 100644 --- a/docs/types/classes/_extrinsicstatus_.dropped.md +++ b/docs/types/classes/_extrinsicstatus_.dropped.md @@ -24,7 +24,7 @@ getencodedLength(): `number` *Inherited from [Null](_null_.null.md).[encodedLength](_null_.null.md#encodedlength)* -*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L16)* +*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L16)* *__description__*: The length of the value when encoded as a Uint8Array @@ -44,7 +44,7 @@ ___ *Inherited from [Null](_null_.null.md).[toHex](_null_.null.md#tohex)* -*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L23)* +*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L23)* *__description__*: Returns a hex string representation of the value @@ -61,7 +61,7 @@ ___ *Inherited from [Null](_null_.null.md).[toJSON](_null_.null.md#tojson)* -*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L30)* +*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L30)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -78,7 +78,7 @@ ___ *Inherited from [Null](_null_.null.md).[toString](_null_.null.md#tostring)* -*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L37)* +*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L37)* *__description__*: Returns the string representation of the value @@ -93,7 +93,7 @@ ___ *Inherited from [Null](_null_.null.md).[toU8a](_null_.null.md#tou8a)* -*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L45)* +*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L45)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_extrinsicstatus_.extrinsicstatus.html b/docs/types/classes/_extrinsicstatus_.extrinsicstatus.html index ea66adffdf..6c0d0b37aa 100644 --- a/docs/types/classes/_extrinsicstatus_.extrinsicstatus.html +++ b/docs/types/classes/_extrinsicstatus_.extrinsicstatus.html @@ -2000,7 +2000,7 @@

constructor

⊕ new ExtrinsicStatus(value: any, index?: undefined | number): ExtrinsicStatus

Overrides EnumType.constructor

-

Defined in ExtrinsicStatus.ts:72

+

Defined in ExtrinsicStatus.ts:72

Parameters:

@@ -2028,7 +2028,7 @@

encodedLength

getencodedLength(): number

Inherited from EnumType.encodedLength

-

Defined in codec/EnumType.ts:97

+

Defined in codec/EnumType.ts:97

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2036,7 +2036,7 @@

isNone

getisNone(): boolean

Inherited from EnumType.isNone

-

Defined in codec/EnumType.ts:104

+

Defined in codec/EnumType.ts:104

description: Checks if the Enum points to a Null type

Returns: boolean


@@ -2044,7 +2044,7 @@

isNull

getisNull(): boolean

Inherited from EnumType.isNull

-

Defined in codec/EnumType.ts:111

+

Defined in codec/EnumType.ts:111

description: Checks if the Enum points to a Null type (deprecated, use isNone)

Returns: boolean


@@ -2052,7 +2052,7 @@

type

gettype(): string

Inherited from EnumType.type

-

Defined in codec/EnumType.ts:118

+

Defined in codec/EnumType.ts:118

description: The name of the type this enum value represents

Returns: string


@@ -2060,7 +2060,7 @@

value

getvalue(): Codec

Inherited from EnumType.value

-

Defined in codec/EnumType.ts:125

+

Defined in codec/EnumType.ts:125

description: The value of the enum

Returns: Codec


@@ -2070,7 +2070,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from EnumType.toHex

-

Defined in codec/EnumType.ts:132

+

Defined in codec/EnumType.ts:132

description: Returns a hex string representation of the value

Returns: string


@@ -2079,7 +2079,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from EnumType.toJSON

-

Defined in codec/EnumType.ts:139

+

Defined in codec/EnumType.ts:139

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2087,7 +2087,7 @@

toNumber

▸ toNumber(): number

Inherited from EnumType.toNumber

-

Defined in codec/EnumType.ts:146

+

Defined in codec/EnumType.ts:146

description: Returns the number representation for the value

Returns: number


@@ -2096,7 +2096,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from EnumType.toString

-

Defined in codec/EnumType.ts:153

+

Defined in codec/EnumType.ts:153

description: Returns the string representation of the value

Returns: string


@@ -2104,7 +2104,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from EnumType.toU8a

-

Defined in codec/EnumType.ts:161

+

Defined in codec/EnumType.ts:161

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2170,7 +2170,7 @@ diff --git a/docs/types/classes/_extrinsicstatus_.extrinsicstatus.md b/docs/types/classes/_extrinsicstatus_.extrinsicstatus.md index 939743021f..2e29e4eed3 100644 --- a/docs/types/classes/_extrinsicstatus_.extrinsicstatus.md +++ b/docs/types/classes/_extrinsicstatus_.extrinsicstatus.md @@ -24,7 +24,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [ExtrinsicStatus.ts:72](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ExtrinsicStatus.ts#L72)* +*Defined in [ExtrinsicStatus.ts:72](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ExtrinsicStatus.ts#L72)* **Parameters:** @@ -47,7 +47,7 @@ getencodedLength(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* -*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L97)* +*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L97)* *__description__*: The length of the value when encoded as a Uint8Array @@ -62,7 +62,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L104)* +*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L104)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type @@ -77,7 +77,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L111)* +*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L111)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone) @@ -92,7 +92,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L118)* +*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L118)* *__description__*: The name of the type this enum value represents @@ -107,7 +107,7 @@ getvalue(): [Codec](../interfaces/_types_.codec.md) *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L125)* +*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L125)* *__description__*: The value of the enum @@ -127,7 +127,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L132)* +*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L132)* *__description__*: Returns a hex string representation of the value @@ -144,7 +144,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L139)* +*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L139)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -159,7 +159,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L146)* +*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L146)* *__description__*: Returns the number representation for the value @@ -176,7 +176,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [codec/EnumType.ts:153](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L153)* +*Defined in [codec/EnumType.ts:153](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L153)* *__description__*: Returns the string representation of the value @@ -191,7 +191,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L161)* +*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L161)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_extrinsicstatus_.finalised.html b/docs/types/classes/_extrinsicstatus_.finalised.html index df313fc58f..07f2605d85 100644 --- a/docs/types/classes/_extrinsicstatus_.finalised.html +++ b/docs/types/classes/_extrinsicstatus_.finalised.html @@ -2003,7 +2003,7 @@

⊕ new Finalised(value?: AnyU8a): Finalised

Inherited from H256.constructor

Overrides U8aFixed.constructor

-

Defined in H256.ts:15

+

Defined in H256.ts:15

Parameters:

@@ -2026,7 +2026,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2035,7 +2035,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2044,7 +2044,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2053,7 +2053,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2085,7 +2085,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2094,7 +2094,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2104,7 +2104,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2112,7 +2112,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2178,7 +2178,7 @@ diff --git a/docs/types/classes/_extrinsicstatus_.finalised.md b/docs/types/classes/_extrinsicstatus_.finalised.md index 96902ceaf3..017e99c0b7 100644 --- a/docs/types/classes/_extrinsicstatus_.finalised.md +++ b/docs/types/classes/_extrinsicstatus_.finalised.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/H256.ts#L15)* +*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/H256.ts#L15)* **Parameters:** @@ -51,7 +51,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -68,7 +68,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -86,7 +86,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -103,7 +103,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -127,7 +127,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -144,7 +144,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -163,7 +163,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -178,7 +178,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_extrinsicstatus_.future.md b/docs/types/classes/_extrinsicstatus_.future.md index d7519e5dbf..a4084aeba3 100644 --- a/docs/types/classes/_extrinsicstatus_.future.md +++ b/docs/types/classes/_extrinsicstatus_.future.md @@ -24,7 +24,7 @@ getencodedLength(): `number` *Inherited from [Null](_null_.null.md).[encodedLength](_null_.null.md#encodedlength)* -*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L16)* +*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L16)* *__description__*: The length of the value when encoded as a Uint8Array @@ -44,7 +44,7 @@ ___ *Inherited from [Null](_null_.null.md).[toHex](_null_.null.md#tohex)* -*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L23)* +*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L23)* *__description__*: Returns a hex string representation of the value @@ -61,7 +61,7 @@ ___ *Inherited from [Null](_null_.null.md).[toJSON](_null_.null.md#tojson)* -*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L30)* +*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L30)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -78,7 +78,7 @@ ___ *Inherited from [Null](_null_.null.md).[toString](_null_.null.md#tostring)* -*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L37)* +*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L37)* *__description__*: Returns the string representation of the value @@ -93,7 +93,7 @@ ___ *Inherited from [Null](_null_.null.md).[toU8a](_null_.null.md#tou8a)* -*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L45)* +*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L45)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_extrinsicstatus_.invalid.md b/docs/types/classes/_extrinsicstatus_.invalid.md index 74ecef12d0..2bc2f6ae08 100644 --- a/docs/types/classes/_extrinsicstatus_.invalid.md +++ b/docs/types/classes/_extrinsicstatus_.invalid.md @@ -24,7 +24,7 @@ getencodedLength(): `number` *Inherited from [Null](_null_.null.md).[encodedLength](_null_.null.md#encodedlength)* -*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L16)* +*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L16)* *__description__*: The length of the value when encoded as a Uint8Array @@ -44,7 +44,7 @@ ___ *Inherited from [Null](_null_.null.md).[toHex](_null_.null.md#tohex)* -*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L23)* +*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L23)* *__description__*: Returns a hex string representation of the value @@ -61,7 +61,7 @@ ___ *Inherited from [Null](_null_.null.md).[toJSON](_null_.null.md#tojson)* -*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L30)* +*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L30)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -78,7 +78,7 @@ ___ *Inherited from [Null](_null_.null.md).[toString](_null_.null.md#tostring)* -*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L37)* +*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L37)* *__description__*: Returns the string representation of the value @@ -93,7 +93,7 @@ ___ *Inherited from [Null](_null_.null.md).[toU8a](_null_.null.md#tou8a)* -*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L45)* +*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L45)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_extrinsicstatus_.ready.md b/docs/types/classes/_extrinsicstatus_.ready.md index 6e934fc3d0..ed5f0e97b8 100644 --- a/docs/types/classes/_extrinsicstatus_.ready.md +++ b/docs/types/classes/_extrinsicstatus_.ready.md @@ -24,7 +24,7 @@ getencodedLength(): `number` *Inherited from [Null](_null_.null.md).[encodedLength](_null_.null.md#encodedlength)* -*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L16)* +*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L16)* *__description__*: The length of the value when encoded as a Uint8Array @@ -44,7 +44,7 @@ ___ *Inherited from [Null](_null_.null.md).[toHex](_null_.null.md#tohex)* -*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L23)* +*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L23)* *__description__*: Returns a hex string representation of the value @@ -61,7 +61,7 @@ ___ *Inherited from [Null](_null_.null.md).[toJSON](_null_.null.md#tojson)* -*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L30)* +*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L30)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -78,7 +78,7 @@ ___ *Inherited from [Null](_null_.null.md).[toString](_null_.null.md#tostring)* -*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L37)* +*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L37)* *__description__*: Returns the string representation of the value @@ -93,7 +93,7 @@ ___ *Inherited from [Null](_null_.null.md).[toU8a](_null_.null.md#tou8a)* -*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L45)* +*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L45)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_extrinsicstatus_.usurped.html b/docs/types/classes/_extrinsicstatus_.usurped.html index b191eda6cd..3bae6a33ea 100644 --- a/docs/types/classes/_extrinsicstatus_.usurped.html +++ b/docs/types/classes/_extrinsicstatus_.usurped.html @@ -2003,7 +2003,7 @@

⊕ new Usurped(value?: AnyU8a): Usurped

Inherited from H256.constructor

Overrides U8aFixed.constructor

-

Defined in H256.ts:15

+

Defined in H256.ts:15

Parameters:

@@ -2026,7 +2026,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2035,7 +2035,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2044,7 +2044,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2053,7 +2053,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2085,7 +2085,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2094,7 +2094,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2104,7 +2104,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2112,7 +2112,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2178,7 +2178,7 @@ diff --git a/docs/types/classes/_extrinsicstatus_.usurped.md b/docs/types/classes/_extrinsicstatus_.usurped.md index 00496164fc..a3dd1a09a1 100644 --- a/docs/types/classes/_extrinsicstatus_.usurped.md +++ b/docs/types/classes/_extrinsicstatus_.usurped.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/H256.ts#L15)* +*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/H256.ts#L15)* **Parameters:** @@ -51,7 +51,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -68,7 +68,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -86,7 +86,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -103,7 +103,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -127,7 +127,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -144,7 +144,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -163,7 +163,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -178,7 +178,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_gas_.gas.html b/docs/types/classes/_gas_.gas.html index 62af2e87b0..32064e4479 100644 --- a/docs/types/classes/_gas_.gas.html +++ b/docs/types/classes/_gas_.gas.html @@ -2001,7 +2001,7 @@

⊕ new Gas(value?: AnyNumber): Gas

Inherited from U64.constructor

Overrides UInt.constructor

-

Defined in U64.ts:14

+

Defined in U64.ts:14

Parameters:

@@ -2026,7 +2026,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2035,7 +2035,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2101,7 +2101,7 @@ diff --git a/docs/types/classes/_gas_.gas.md b/docs/types/classes/_gas_.gas.md index 6f1055191b..d25ca16845 100644 --- a/docs/types/classes/_gas_.gas.md +++ b/docs/types/classes/_gas_.gas.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/U64.ts#L14)* +*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/U64.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -69,7 +69,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_h256_.h256.html b/docs/types/classes/_h256_.h256.html index 64be570ba1..5500689bed 100644 --- a/docs/types/classes/_h256_.h256.html +++ b/docs/types/classes/_h256_.h256.html @@ -2003,7 +2003,7 @@

constructor

⊕ new H256(value?: AnyU8a): H256

Overrides U8aFixed.constructor

-

Defined in H256.ts:15

+

Defined in H256.ts:15

Parameters:

@@ -2026,7 +2026,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2035,7 +2035,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2044,7 +2044,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2053,7 +2053,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2085,7 +2085,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2094,7 +2094,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2104,7 +2104,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2112,7 +2112,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2178,7 +2178,7 @@ diff --git a/docs/types/classes/_h256_.h256.md b/docs/types/classes/_h256_.h256.md index 81be00be8f..80764082e8 100644 --- a/docs/types/classes/_h256_.h256.md +++ b/docs/types/classes/_h256_.h256.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/H256.ts#L15)* +*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/H256.ts#L15)* **Parameters:** @@ -51,7 +51,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -68,7 +68,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -86,7 +86,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -103,7 +103,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -127,7 +127,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -144,7 +144,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -163,7 +163,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -178,7 +178,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_h512_.h512.html b/docs/types/classes/_h512_.h512.html index 3b37cd945b..8ba5b42aa5 100644 --- a/docs/types/classes/_h512_.h512.html +++ b/docs/types/classes/_h512_.h512.html @@ -2003,7 +2003,7 @@

constructor

⊕ new H512(value?: AnyU8a): H512

Overrides U8aFixed.constructor

-

Defined in H512.ts:14

+

Defined in H512.ts:14

Parameters:

@@ -2026,7 +2026,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2035,7 +2035,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2044,7 +2044,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2053,7 +2053,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2085,7 +2085,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2094,7 +2094,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2104,7 +2104,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2112,7 +2112,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2178,7 +2178,7 @@ diff --git a/docs/types/classes/_h512_.h512.md b/docs/types/classes/_h512_.h512.md index 323bd5c373..0087f2236d 100644 --- a/docs/types/classes/_h512_.h512.md +++ b/docs/types/classes/_h512_.h512.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/H512.ts#L14)* +*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/H512.ts#L14)* **Parameters:** @@ -51,7 +51,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -68,7 +68,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -86,7 +86,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -103,7 +103,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -127,7 +127,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -144,7 +144,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -163,7 +163,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -178,7 +178,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_hash_.hash.html b/docs/types/classes/_hash_.hash.html index bcade9c60f..c85b345496 100644 --- a/docs/types/classes/_hash_.hash.html +++ b/docs/types/classes/_hash_.hash.html @@ -2006,7 +2006,7 @@

⊕ new Hash(value?: AnyU8a): Hash

Inherited from H256.constructor

Overrides U8aFixed.constructor

-

Defined in H256.ts:15

+

Defined in H256.ts:15

Parameters:

@@ -2029,7 +2029,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2038,7 +2038,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2047,7 +2047,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2056,7 +2056,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2088,7 +2088,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2097,7 +2097,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2107,7 +2107,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2115,7 +2115,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2181,7 +2181,7 @@ diff --git a/docs/types/classes/_hash_.hash.md b/docs/types/classes/_hash_.hash.md index b339b7c2a5..4478b4307d 100644 --- a/docs/types/classes/_hash_.hash.md +++ b/docs/types/classes/_hash_.hash.md @@ -35,7 +35,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/H256.ts#L15)* +*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/H256.ts#L15)* **Parameters:** @@ -57,7 +57,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -74,7 +74,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -92,7 +92,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -109,7 +109,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -133,7 +133,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -150,7 +150,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -169,7 +169,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -184,7 +184,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_header_.header.html b/docs/types/classes/_header_.header.html index 7f8e57d513..9f9b822cec 100644 --- a/docs/types/classes/_header_.header.html +++ b/docs/types/classes/_header_.header.html @@ -2005,7 +2005,7 @@

constructor

⊕ new Header(value?: HeaderValue | Uint8Array): Header

Overrides Struct.constructor

-

Defined in Header.ts:29

+

Defined in Header.ts:29

Parameters:

@@ -2029,21 +2029,21 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


blockNumber

getblockNumber(): BlockNumber

-

Defined in Header.ts:43

+

Defined in Header.ts:43

description: The wrapped BlockNumber

Returns: BlockNumber


digest

getdigest(): Digest

-

Defined in Header.ts:50

+

Defined in Header.ts:50

description: The wrapped Digest

Returns: Digest


@@ -2051,35 +2051,35 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


extrinsicsRoot

getextrinsicsRoot(): Hash

-

Defined in Header.ts:57

+

Defined in Header.ts:57

description: The wrapped extrisics root as a Hash

Returns: Hash


hash

gethash(): Hash

-

Defined in Header.ts:64

+

Defined in Header.ts:64

description: Convenience method, encodes the header and calculates the Hash

Returns: Hash


parentHash

getparentHash(): Hash

-

Defined in Header.ts:73

+

Defined in Header.ts:73

description: The wrapped parent as a Hash

Returns: Hash


stateRoot

getstateRoot(): Hash

-

Defined in Header.ts:80

+

Defined in Header.ts:80

description: The wrapped state root as a Hash

Returns: Hash


@@ -2089,7 +2089,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2114,7 +2114,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2137,7 +2137,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2146,7 +2146,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2155,7 +2155,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2164,7 +2164,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2172,7 +2172,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2199,7 +2199,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2262,7 +2262,7 @@ diff --git a/docs/types/classes/_header_.header.md b/docs/types/classes/_header_.header.md index d54a4b7afb..35408011af 100644 --- a/docs/types/classes/_header_.header.md +++ b/docs/types/classes/_header_.header.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Header.ts:29](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Header.ts#L29)* +*Defined in [Header.ts:29](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Header.ts#L29)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -64,7 +64,7 @@ ___ getblockNumber(): [BlockNumber](_blocknumber_.blocknumber.md) -*Defined in [Header.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Header.ts#L43)* +*Defined in [Header.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Header.ts#L43)* *__description__*: The wrapped [BlockNumber](_blocknumber_.blocknumber.md) @@ -77,7 +77,7 @@ ___ getdigest(): [Digest](_digest_.digest.md) -*Defined in [Header.ts:50](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Header.ts#L50)* +*Defined in [Header.ts:50](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Header.ts#L50)* *__description__*: The wrapped [Digest](_digest_.digest.md) @@ -92,7 +92,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -105,7 +105,7 @@ ___ getextrinsicsRoot(): [Hash](_hash_.hash.md) -*Defined in [Header.ts:57](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Header.ts#L57)* +*Defined in [Header.ts:57](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Header.ts#L57)* *__description__*: The wrapped extrisics root as a [Hash](_hash_.hash.md) @@ -118,7 +118,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Header.ts:64](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Header.ts#L64)* +*Defined in [Header.ts:64](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Header.ts#L64)* *__description__*: Convenience method, encodes the header and calculates the [Hash](_hash_.hash.md) @@ -131,7 +131,7 @@ ___ getparentHash(): [Hash](_hash_.hash.md) -*Defined in [Header.ts:73](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Header.ts#L73)* +*Defined in [Header.ts:73](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Header.ts#L73)* *__description__*: The wrapped parent as a [Hash](_hash_.hash.md) @@ -144,7 +144,7 @@ ___ getstateRoot(): [Hash](_hash_.hash.md) -*Defined in [Header.ts:80](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Header.ts#L80)* +*Defined in [Header.ts:80](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Header.ts#L80)* *__description__*: The wrapped state root as a [Hash](_hash_.hash.md) @@ -164,7 +164,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -185,7 +185,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -206,7 +206,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -223,7 +223,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -240,7 +240,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -257,7 +257,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -272,7 +272,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -293,7 +293,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_health_.health.md b/docs/types/classes/_health_.health.md index abd5f1f8a3..f2744d1a7e 100644 --- a/docs/types/classes/_health_.health.md +++ b/docs/types/classes/_health_.health.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Health.ts:13](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Health.ts#L13)* +*Defined in [Health.ts:13](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Health.ts#L13)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -62,7 +62,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -75,7 +75,7 @@ ___ getisSyncing(): [Bool](_bool_.bool.md) -*Defined in [Health.ts:24](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Health.ts#L24)* +*Defined in [Health.ts:24](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Health.ts#L24)* *__description__*: The sync status @@ -88,7 +88,7 @@ ___ getpeers(): [U32](_u32_.u32.md) -*Defined in [Health.ts:31](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Health.ts#L31)* +*Defined in [Health.ts:31](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Health.ts#L31)* *__description__*: The numbers of peers as [U32](_u32_.u32.md) @@ -108,7 +108,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -129,7 +129,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -150,7 +150,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -167,7 +167,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -184,7 +184,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -201,7 +201,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -216,7 +216,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -237,7 +237,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_i128_.i128.md b/docs/types/classes/_i128_.i128.md index 33a9d86d79..8524d67e19 100644 --- a/docs/types/classes/_i128_.i128.md +++ b/docs/types/classes/_i128_.i128.md @@ -24,7 +24,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [I128.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/I128.ts#L14)* +*Defined in [I128.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/I128.ts#L14)* **Parameters:** @@ -50,7 +50,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -67,7 +67,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_i16_.i16.md b/docs/types/classes/_i16_.i16.md index 71e1e36af9..5cbc08f673 100644 --- a/docs/types/classes/_i16_.i16.md +++ b/docs/types/classes/_i16_.i16.md @@ -24,7 +24,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [I16.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/I16.ts#L14)* +*Defined in [I16.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/I16.ts#L14)* **Parameters:** @@ -50,7 +50,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -67,7 +67,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_i256_.i256.md b/docs/types/classes/_i256_.i256.md index 7e6df6735e..f94b89ad0d 100644 --- a/docs/types/classes/_i256_.i256.md +++ b/docs/types/classes/_i256_.i256.md @@ -24,7 +24,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [I256.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/I256.ts#L14)* +*Defined in [I256.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/I256.ts#L14)* **Parameters:** @@ -50,7 +50,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -67,7 +67,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_i32_.i32.md b/docs/types/classes/_i32_.i32.md index cdf358529d..9346d5d3b9 100644 --- a/docs/types/classes/_i32_.i32.md +++ b/docs/types/classes/_i32_.i32.md @@ -24,7 +24,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [I32.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/I32.ts#L14)* +*Defined in [I32.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/I32.ts#L14)* **Parameters:** @@ -50,7 +50,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -67,7 +67,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_i64_.i64.md b/docs/types/classes/_i64_.i64.md index e3d9dbaa09..5cd787d301 100644 --- a/docs/types/classes/_i64_.i64.md +++ b/docs/types/classes/_i64_.i64.md @@ -24,7 +24,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [I64.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/I64.ts#L14)* +*Defined in [I64.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/I64.ts#L14)* **Parameters:** @@ -50,7 +50,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -67,7 +67,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_i8_.i8.md b/docs/types/classes/_i8_.i8.md index 011446a9fc..dc2dbe1f17 100644 --- a/docs/types/classes/_i8_.i8.md +++ b/docs/types/classes/_i8_.i8.md @@ -28,7 +28,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [I8.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/I8.ts#L14)* +*Defined in [I8.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/I8.ts#L14)* **Parameters:** @@ -54,7 +54,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -71,7 +71,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_inherentofflinereport_.inherentofflinereport.md b/docs/types/classes/_inherentofflinereport_.inherentofflinereport.md index 8a9cb4bab5..fd82a5ada6 100644 --- a/docs/types/classes/_inherentofflinereport_.inherentofflinereport.md +++ b/docs/types/classes/_inherentofflinereport_.inherentofflinereport.md @@ -27,7 +27,7 @@ *Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L22)* +*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L22)* **Parameters:** @@ -50,7 +50,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -65,7 +65,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -85,7 +85,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L126)* +*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L126)* *__description__*: Filters the array with the callback @@ -109,7 +109,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L135)* +*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L135)* *__description__*: Maps the array with the callback @@ -134,7 +134,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Converts the Object to an standard JavaScript Array @@ -151,7 +151,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Returns a hex string representation of the value @@ -168,7 +168,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -187,7 +187,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L100)* +*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L100)* *__description__*: Returns the string representation of the value @@ -202,7 +202,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L109)* +*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L109)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -223,7 +223,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_justification_.justification.html b/docs/types/classes/_justification_.justification.html index c372c1801f..3314c7511b 100644 --- a/docs/types/classes/_justification_.justification.html +++ b/docs/types/classes/_justification_.justification.html @@ -2003,7 +2003,7 @@

⊕ new Justification(value?: AnyU8a): Justification

Inherited from Bytes.constructor

Overrides U8a.constructor

-

Defined in Bytes.ts:18

+

Defined in Bytes.ts:18

Parameters:

@@ -2027,7 +2027,7 @@

getencodedLength(): number

Inherited from Bytes.encodedLength

Overrides U8a.encodedLength

-

Defined in Bytes.ts:64

+

Defined in Bytes.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2036,7 +2036,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2046,7 +2046,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2078,7 +2078,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2087,7 +2087,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2097,7 +2097,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2106,7 +2106,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Bytes.toU8a

Overrides U8a.toU8a

-

Defined in Bytes.ts:72

+

Defined in Bytes.ts:72

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2172,7 +2172,7 @@ diff --git a/docs/types/classes/_justification_.justification.md b/docs/types/classes/_justification_.justification.md index 28b4acd7ad..f05e2c7f59 100644 --- a/docs/types/classes/_justification_.justification.md +++ b/docs/types/classes/_justification_.justification.md @@ -29,7 +29,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bytes.ts#L18)* +*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bytes.ts#L18)* **Parameters:** @@ -53,7 +53,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bytes.ts#L64)* +*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bytes.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -70,7 +70,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -90,7 +90,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -114,7 +114,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -131,7 +131,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -150,7 +150,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -167,7 +167,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bytes.ts#L72)* +*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bytes.ts#L72)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_justification_.rhdjustification.html b/docs/types/classes/_justification_.rhdjustification.html index 9e1180c167..6f7752c983 100644 --- a/docs/types/classes/_justification_.rhdjustification.html +++ b/docs/types/classes/_justification_.rhdjustification.html @@ -2005,7 +2005,7 @@

constructor

⊕ new RhdJustification(value?: RhdJustificationValue | Uint8Array): RhdJustification

Overrides Struct.constructor

-

Defined in Justification.ts:33

+

Defined in Justification.ts:33

Parameters:

@@ -2029,7 +2029,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2037,28 +2037,28 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


hash

gethash(): Hash

-

Defined in Justification.ts:47

+

Defined in Justification.ts:47

description: The justification Hash

Returns: Hash


roundNumber

getroundNumber(): U32

-

Defined in Justification.ts:54

+

Defined in Justification.ts:54

description: The round this justification wraps as a U32

Returns: U32


signatures

getsignatures(): Vector<BftAuthoritySignature>

-

Defined in Justification.ts:61

+

Defined in Justification.ts:61

description: The BftAuthoritySignature array

Returns: Vector<BftAuthoritySignature>


@@ -2068,7 +2068,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2093,7 +2093,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2116,7 +2116,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2125,7 +2125,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2134,7 +2134,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2143,7 +2143,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2151,7 +2151,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2178,7 +2178,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2241,7 +2241,7 @@ diff --git a/docs/types/classes/_justification_.rhdjustification.md b/docs/types/classes/_justification_.rhdjustification.md index 13b46da2fb..2149b51916 100644 --- a/docs/types/classes/_justification_.rhdjustification.md +++ b/docs/types/classes/_justification_.rhdjustification.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Justification.ts:33](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Justification.ts#L33)* +*Defined in [Justification.ts:33](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Justification.ts#L33)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -66,7 +66,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -79,7 +79,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Justification.ts:47](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Justification.ts#L47)* +*Defined in [Justification.ts:47](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Justification.ts#L47)* *__description__*: The justification [Hash](_hash_.hash.md) @@ -92,7 +92,7 @@ ___ getroundNumber(): [U32](_u32_.u32.md) -*Defined in [Justification.ts:54](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Justification.ts#L54)* +*Defined in [Justification.ts:54](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Justification.ts#L54)* *__description__*: The round this justification wraps as a [U32](_u32_.u32.md) @@ -105,7 +105,7 @@ ___ getsignatures(): [Vector](_codec_vector_.vector.md)<[BftAuthoritySignature](_bft_.bftauthoritysignature.md)> -*Defined in [Justification.ts:61](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Justification.ts#L61)* +*Defined in [Justification.ts:61](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Justification.ts#L61)* *__description__*: The [BftAuthoritySignature](_bft_.bftauthoritysignature.md) array @@ -125,7 +125,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -146,7 +146,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -167,7 +167,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -184,7 +184,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -201,7 +201,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -218,7 +218,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -233,7 +233,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -254,7 +254,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_keyvalue_.keyvalue.html b/docs/types/classes/_keyvalue_.keyvalue.html index 2a8e671827..7ed0be1567 100644 --- a/docs/types/classes/_keyvalue_.keyvalue.html +++ b/docs/types/classes/_keyvalue_.keyvalue.html @@ -2005,7 +2005,7 @@

constructor

⊕ new KeyValue(value?: KeyValueValue | Uint8Array): KeyValue

Overrides Struct.constructor

-

Defined in KeyValue.ts:26

+

Defined in KeyValue.ts:26

Parameters:

@@ -2029,7 +2029,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2037,21 +2037,21 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


key

getkey(): StorageKey

-

Defined in KeyValue.ts:37

+

Defined in KeyValue.ts:37

description: The StorageKey

Returns: StorageKey


value

getvalue(): StorageData

-

Defined in KeyValue.ts:44

+

Defined in KeyValue.ts:44

description: The StorageData

Returns: StorageData


@@ -2061,7 +2061,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2086,7 +2086,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2109,7 +2109,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2118,7 +2118,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2127,7 +2127,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2136,7 +2136,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2144,7 +2144,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2171,7 +2171,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2234,7 +2234,7 @@ diff --git a/docs/types/classes/_keyvalue_.keyvalue.md b/docs/types/classes/_keyvalue_.keyvalue.md index 9cac9f80b4..7068838b94 100644 --- a/docs/types/classes/_keyvalue_.keyvalue.md +++ b/docs/types/classes/_keyvalue_.keyvalue.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [KeyValue.ts:26](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/KeyValue.ts#L26)* +*Defined in [KeyValue.ts:26](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/KeyValue.ts#L26)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -66,7 +66,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -79,7 +79,7 @@ ___ getkey(): [StorageKey](_storagekey_.storagekey.md) -*Defined in [KeyValue.ts:37](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/KeyValue.ts#L37)* +*Defined in [KeyValue.ts:37](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/KeyValue.ts#L37)* *__description__*: The [StorageKey](_storagekey_.storagekey.md) @@ -92,7 +92,7 @@ ___ getvalue(): [StorageData](_storagedata_.storagedata.md) -*Defined in [KeyValue.ts:44](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/KeyValue.ts#L44)* +*Defined in [KeyValue.ts:44](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/KeyValue.ts#L44)* *__description__*: The [StorageData](_storagedata_.storagedata.md) @@ -112,7 +112,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -133,7 +133,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -154,7 +154,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -171,7 +171,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -188,7 +188,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -205,7 +205,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -220,7 +220,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -241,7 +241,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_keyvalue_.keyvalueoption.html b/docs/types/classes/_keyvalue_.keyvalueoption.html index 4d6ce9c2f0..589a84de98 100644 --- a/docs/types/classes/_keyvalue_.keyvalueoption.html +++ b/docs/types/classes/_keyvalue_.keyvalueoption.html @@ -2002,7 +2002,7 @@

constructor

⊕ new KeyValueOption(value?: KeyValueOptionValue | Uint8Array): KeyValueOption

Overrides Tuple.constructor

-

Defined in KeyValue.ts:58

+

Defined in KeyValue.ts:58

Parameters:

@@ -2026,7 +2026,7 @@

Types

getTypes(): Array<string>

Inherited from Tuple.Types

-

Defined in codec/Tuple.ts:68

+

Defined in codec/Tuple.ts:68

description: The types definition of the tuple

Returns: Array<string>


@@ -2034,21 +2034,21 @@

encodedLength

getencodedLength(): number

Inherited from Tuple.encodedLength

-

Defined in codec/Tuple.ts:59

+

Defined in codec/Tuple.ts:59

description: The length of the value when encoded as a Uint8Array

Returns: number


key

getkey(): StorageKey

-

Defined in KeyValue.ts:69

+

Defined in KeyValue.ts:69

description: The StorageKey

Returns: StorageKey


value

getvalue(): Option<StorageData>

-

Defined in KeyValue.ts:76

+

Defined in KeyValue.ts:76

description: The Option StorageData

Returns: Option<StorageData>


@@ -2058,7 +2058,7 @@

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Inherited from Tuple.filter

Overrides Array.filter

-

Defined in codec/Tuple.ts:126

+

Defined in codec/Tuple.ts:126

description: Filters the array with the callback

Parameters:

@@ -2089,7 +2089,7 @@

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Tuple.map

Overrides Array.map

-

Defined in codec/Tuple.ts:135

+

Defined in codec/Tuple.ts:135

description: Maps the array with the callback

Type parameters:

U

@@ -2121,7 +2121,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

-

Defined in codec/Tuple.ts:77

+

Defined in codec/Tuple.ts:77

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2130,7 +2130,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

-

Defined in codec/Tuple.ts:84

+

Defined in codec/Tuple.ts:84

description: Returns a hex string representation of the value

Returns: string


@@ -2139,7 +2139,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

-

Defined in codec/Tuple.ts:91

+

Defined in codec/Tuple.ts:91

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2149,7 +2149,7 @@

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:100

+

Defined in codec/Tuple.ts:100

description: Returns the string representation of the value

Returns: string


@@ -2157,7 +2157,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Tuple.toU8a

-

Defined in codec/Tuple.ts:109

+

Defined in codec/Tuple.ts:109

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2184,7 +2184,7 @@

<Static> with

▸ with(Types: TupleConstructors): Constructor<Tuple>

Inherited from Tuple.with

-

Defined in codec/Tuple.ts:48

+

Defined in codec/Tuple.ts:48

Parameters:

@@ -2245,7 +2245,7 @@ diff --git a/docs/types/classes/_keyvalue_.keyvalueoption.md b/docs/types/classes/_keyvalue_.keyvalueoption.md index 26770772a3..bed20e3483 100644 --- a/docs/types/classes/_keyvalue_.keyvalueoption.md +++ b/docs/types/classes/_keyvalue_.keyvalueoption.md @@ -27,7 +27,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [KeyValue.ts:58](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/KeyValue.ts#L58)* +*Defined in [KeyValue.ts:58](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/KeyValue.ts#L58)* **Parameters:** @@ -49,7 +49,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -64,7 +64,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -77,7 +77,7 @@ ___ getkey(): [StorageKey](_storagekey_.storagekey.md) -*Defined in [KeyValue.ts:69](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/KeyValue.ts#L69)* +*Defined in [KeyValue.ts:69](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/KeyValue.ts#L69)* *__description__*: The [StorageKey](_storagekey_.storagekey.md) @@ -90,7 +90,7 @@ ___ getvalue(): [Option](_codec_option_.option.md)<[StorageData](_storagedata_.storagedata.md)> -*Defined in [KeyValue.ts:76](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/KeyValue.ts#L76)* +*Defined in [KeyValue.ts:76](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/KeyValue.ts#L76)* *__description__*: The [Option](_codec_option_.option.md) [StorageData](_storagedata_.storagedata.md) @@ -110,7 +110,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L126)* +*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L126)* *__description__*: Filters the array with the callback @@ -134,7 +134,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L135)* +*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L135)* *__description__*: Maps the array with the callback @@ -159,7 +159,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Converts the Object to an standard JavaScript Array @@ -176,7 +176,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Returns a hex string representation of the value @@ -193,7 +193,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -212,7 +212,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L100)* +*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L100)* *__description__*: Returns the string representation of the value @@ -227,7 +227,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L109)* +*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L109)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -248,7 +248,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_lockperiods_.lockperiods.md b/docs/types/classes/_lockperiods_.lockperiods.md index c8486146ed..552d8b2c06 100644 --- a/docs/types/classes/_lockperiods_.lockperiods.md +++ b/docs/types/classes/_lockperiods_.lockperiods.md @@ -26,7 +26,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [I8.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/I8.ts#L14)* +*Defined in [I8.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/I8.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -69,7 +69,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_metadata_calls_.outerdispatchcall.md b/docs/types/classes/_metadata_calls_.outerdispatchcall.md index 6f7fe3f8f7..31961d49c9 100644 --- a/docs/types/classes/_metadata_calls_.outerdispatchcall.md +++ b/docs/types/classes/_metadata_calls_.outerdispatchcall.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Calls.ts:10](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Calls.ts#L10)* +*Defined in [Metadata/Calls.ts:10](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Calls.ts#L10)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -62,7 +62,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -75,7 +75,7 @@ ___ getindex(): [U16](_u16_.u16.md) -*Defined in [Metadata/Calls.ts:22](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Calls.ts#L22)* +*Defined in [Metadata/Calls.ts:22](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Calls.ts#L22)* *__description__*: The [U16](_u16_.u16.md) index for the call @@ -88,7 +88,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/Calls.ts:29](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Calls.ts#L29)* +*Defined in [Metadata/Calls.ts:29](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Calls.ts#L29)* *__description__*: The name for the call @@ -101,7 +101,7 @@ ___ getprefix(): [Text](_text_.text.md) -*Defined in [Metadata/Calls.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Calls.ts#L36)* +*Defined in [Metadata/Calls.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Calls.ts#L36)* *__description__*: The call prefix (or section) @@ -121,7 +121,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -142,7 +142,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -163,7 +163,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -180,7 +180,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -197,7 +197,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -214,7 +214,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -229,7 +229,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -250,7 +250,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_calls_.outerdispatchmetadata.md b/docs/types/classes/_metadata_calls_.outerdispatchmetadata.md index 540fe15c14..4de3e6714a 100644 --- a/docs/types/classes/_metadata_calls_.outerdispatchmetadata.md +++ b/docs/types/classes/_metadata_calls_.outerdispatchmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Calls.ts:41](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Calls.ts#L41)* +*Defined in [Metadata/Calls.ts:41](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Calls.ts#L41)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -60,7 +60,7 @@ ___ getcalls(): [Vector](_codec_vector_.vector.md)<[OuterDispatchCall](_metadata_calls_.outerdispatchcall.md)> -*Defined in [Metadata/Calls.ts:52](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Calls.ts#L52)* +*Defined in [Metadata/Calls.ts:52](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Calls.ts#L52)* *__description__*: The \[\[OuterDispathCall\]\] wrapped @@ -75,7 +75,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -88,7 +88,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/Calls.ts:59](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Calls.ts#L59)* +*Defined in [Metadata/Calls.ts:59](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Calls.ts#L59)* *__description__*: The name for the dispatch @@ -108,7 +108,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -129,7 +129,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -150,7 +150,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -167,7 +167,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -184,7 +184,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -201,7 +201,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -216,7 +216,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -237,7 +237,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_events_.eventmetadata.md b/docs/types/classes/_metadata_events_.eventmetadata.md index 7df17b6768..29de61562c 100644 --- a/docs/types/classes/_metadata_events_.eventmetadata.md +++ b/docs/types/classes/_metadata_events_.eventmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Events.ts:11](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Events.ts#L11)* +*Defined in [Metadata/Events.ts:11](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Events.ts#L11)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -60,7 +60,7 @@ ___ getarguments(): [Vector](_codec_vector_.vector.md)<[Type](_type_.type.md)> -*Defined in [Metadata/Events.ts:23](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Events.ts#L23)* +*Defined in [Metadata/Events.ts:23](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Events.ts#L23)* *__description__*: The arguments of [Type](_metadata_events_.eventmetadata.md#type) @@ -73,7 +73,7 @@ ___ getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> -*Defined in [Metadata/Events.ts:30](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Events.ts#L30)* +*Defined in [Metadata/Events.ts:30](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Events.ts#L30)* *__description__*: The [Text](_text_.text.md) documentation @@ -88,7 +88,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -101,7 +101,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/Events.ts:37](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Events.ts#L37)* +*Defined in [Metadata/Events.ts:37](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Events.ts#L37)* *__description__*: The name for the event @@ -121,7 +121,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -142,7 +142,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -163,7 +163,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -180,7 +180,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -197,7 +197,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -214,7 +214,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -229,7 +229,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -250,7 +250,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_events_.outereventmetadata.md b/docs/types/classes/_metadata_events_.outereventmetadata.md index c549eac3f0..259f82fed4 100644 --- a/docs/types/classes/_metadata_events_.outereventmetadata.md +++ b/docs/types/classes/_metadata_events_.outereventmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Events.ts:65](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Events.ts#L65)* +*Defined in [Metadata/Events.ts:65](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Events.ts#L65)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -62,7 +62,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -75,7 +75,7 @@ ___ getevents(): [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_events_.outereventmetadataevent.md)> -*Defined in [Metadata/Events.ts:76](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Events.ts#L76)* +*Defined in [Metadata/Events.ts:76](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Events.ts#L76)* *__description__*: The [OuterEventMetadataEvent](_metadata_events_.outereventmetadataevent.md) @@ -88,7 +88,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/Events.ts:83](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Events.ts#L83)* +*Defined in [Metadata/Events.ts:83](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Events.ts#L83)* *__description__*: The name of the event @@ -108,7 +108,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -129,7 +129,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -150,7 +150,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -167,7 +167,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -184,7 +184,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -201,7 +201,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -216,7 +216,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -237,7 +237,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_events_.outereventmetadataevent.md b/docs/types/classes/_metadata_events_.outereventmetadataevent.md index 2c86e716f1..9070ba76e5 100644 --- a/docs/types/classes/_metadata_events_.outereventmetadataevent.md +++ b/docs/types/classes/_metadata_events_.outereventmetadataevent.md @@ -23,7 +23,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [Metadata/Events.ts:42](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Events.ts#L42)* +*Defined in [Metadata/Events.ts:42](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Events.ts#L42)* **Parameters:** @@ -45,7 +45,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -60,7 +60,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -73,7 +73,7 @@ ___ getevents(): [Vector](_codec_vector_.vector.md)<[EventMetadata](_metadata_events_.eventmetadata.md)> -*Defined in [Metadata/Events.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Events.ts#L53)* +*Defined in [Metadata/Events.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Events.ts#L53)* *__description__*: The [EventMetadata](_metadata_events_.eventmetadata.md) @@ -86,7 +86,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/Events.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Events.ts#L60)* +*Defined in [Metadata/Events.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Events.ts#L60)* *__description__*: The name of the section @@ -106,7 +106,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L126)* +*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L126)* *__description__*: Filters the array with the callback @@ -130,7 +130,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L135)* +*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L135)* *__description__*: Maps the array with the callback @@ -155,7 +155,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Converts the Object to an standard JavaScript Array @@ -172,7 +172,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Returns a hex string representation of the value @@ -189,7 +189,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -208,7 +208,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L100)* +*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L100)* *__description__*: Returns the string representation of the value @@ -223,7 +223,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L109)* +*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L109)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -244,7 +244,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_metadata_index_.metadata.md b/docs/types/classes/_metadata_index_.metadata.md index d55a2e7b2f..5b73f1a9e6 100644 --- a/docs/types/classes/_metadata_index_.metadata.md +++ b/docs/types/classes/_metadata_index_.metadata.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/index.ts:39](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/index.ts#L39)* +*Defined in [Metadata/index.ts:39](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/index.ts#L39)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -64,7 +64,7 @@ ___ getcalls(): [Vector](_codec_vector_.vector.md)<[OuterDispatchCall](_metadata_calls_.outerdispatchcall.md)> -*Defined in [Metadata/index.ts:73](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/index.ts#L73)* +*Defined in [Metadata/index.ts:73](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/index.ts#L73)* *__description__*: Wrapped [OuterDispatchCall](_metadata_calls_.outerdispatchcall.md) @@ -79,7 +79,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -92,7 +92,7 @@ ___ getevents(): [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_events_.outereventmetadataevent.md)> -*Defined in [Metadata/index.ts:80](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/index.ts#L80)* +*Defined in [Metadata/index.ts:80](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/index.ts#L80)* *__description__*: Wrapped [OuterEventMetadataEvent](_metadata_events_.outereventmetadataevent.md) @@ -105,7 +105,7 @@ ___ getmodules(): [Vector](_codec_vector_.vector.md)<[RuntimeModuleMetadata](_metadata_modules_.runtimemodulemetadata.md)> -*Defined in [Metadata/index.ts:87](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/index.ts#L87)* +*Defined in [Metadata/index.ts:87](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/index.ts#L87)* *__description__*: Wrapped [RuntimeModuleMetadata](_metadata_modules_.runtimemodulemetadata.md) @@ -125,7 +125,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -146,7 +146,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -165,7 +165,7 @@ ___ ▸ **getUniqTypes**(): `Array`<`string`> -*Defined in [Metadata/index.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/index.ts#L122)* +*Defined in [Metadata/index.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/index.ts#L122)* *__description__*: Helper to retrieve a list of all type that are found, sorted and de-deuplicated @@ -180,7 +180,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -197,7 +197,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -214,7 +214,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -231,7 +231,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -246,7 +246,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -265,7 +265,7 @@ ___ ▸ **decodeMetadata**(value: *`string` | `Uint8Array` | `object`*): `object` | `Uint8Array` -*Defined in [Metadata/index.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/index.ts#L48)* +*Defined in [Metadata/index.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/index.ts#L48)* **Parameters:** @@ -284,7 +284,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_modules_.callmetadata.md b/docs/types/classes/_metadata_modules_.callmetadata.md index 2cd1b6f7e5..cd958e4fb0 100644 --- a/docs/types/classes/_metadata_modules_.callmetadata.md +++ b/docs/types/classes/_metadata_modules_.callmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Modules.ts:79](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L79)* +*Defined in [Metadata/Modules.ts:79](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L79)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -62,7 +62,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -75,7 +75,7 @@ ___ getfunctions(): [Vector](_codec_vector_.vector.md)<[FunctionMetadata](_metadata_modules_.functionmetadata.md)> -*Defined in [Metadata/Modules.ts:90](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L90)* +*Defined in [Metadata/Modules.ts:90](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L90)* *__description__*: The functions available as [FunctionMetadata](_metadata_modules_.functionmetadata.md) @@ -88,7 +88,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/Modules.ts:97](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L97)* +*Defined in [Metadata/Modules.ts:97](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L97)* *__description__*: The section name @@ -108,7 +108,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -129,7 +129,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -150,7 +150,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -167,7 +167,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -184,7 +184,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -201,7 +201,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -216,7 +216,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -237,7 +237,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_modules_.functionargumentmetadata.md b/docs/types/classes/_metadata_modules_.functionargumentmetadata.md index d5940fa313..2098ec5e4e 100644 --- a/docs/types/classes/_metadata_modules_.functionargumentmetadata.md +++ b/docs/types/classes/_metadata_modules_.functionargumentmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Modules.ts:17](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L17)* +*Defined in [Metadata/Modules.ts:17](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L17)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -62,7 +62,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -75,7 +75,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/Modules.ts:28](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L28)* +*Defined in [Metadata/Modules.ts:28](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L28)* *__description__*: The argument name @@ -88,7 +88,7 @@ ___ gettype(): [Type](_type_.type.md) -*Defined in [Metadata/Modules.ts:35](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L35)* +*Defined in [Metadata/Modules.ts:35](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L35)* *__description__*: The [Type](_metadata_modules_.functionargumentmetadata.md#type) @@ -108,7 +108,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -129,7 +129,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -150,7 +150,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -167,7 +167,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -184,7 +184,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -201,7 +201,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -216,7 +216,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -237,7 +237,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_modules_.functionmetadata.md b/docs/types/classes/_metadata_modules_.functionmetadata.md index a1ea2f8a2e..11e7874b56 100644 --- a/docs/types/classes/_metadata_modules_.functionmetadata.md +++ b/docs/types/classes/_metadata_modules_.functionmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Modules.ts:40](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L40)* +*Defined in [Metadata/Modules.ts:40](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L40)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -60,7 +60,7 @@ ___ getarguments(): [Vector](_codec_vector_.vector.md)<[FunctionArgumentMetadata](_metadata_modules_.functionargumentmetadata.md)> -*Defined in [Metadata/Modules.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L53)* +*Defined in [Metadata/Modules.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L53)* *__description__*: The [FunctionArgumentMetadata](_metadata_modules_.functionargumentmetadata.md) for arguments @@ -73,7 +73,7 @@ ___ getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> -*Defined in [Metadata/Modules.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L60)* +*Defined in [Metadata/Modules.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L60)* *__description__*: The [Text](_text_.text.md) documentation @@ -88,7 +88,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -101,7 +101,7 @@ ___ getid(): [U16](_u16_.u16.md) -*Defined in [Metadata/Modules.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L67)* +*Defined in [Metadata/Modules.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L67)* *__description__*: The `[sectionIndex, methodIndex]` call id @@ -114,7 +114,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/Modules.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L74)* +*Defined in [Metadata/Modules.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L74)* *__description__*: The call name @@ -134,7 +134,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -155,7 +155,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -176,7 +176,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -193,7 +193,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -210,7 +210,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -227,7 +227,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -242,7 +242,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -263,7 +263,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_modules_.modulemetadata.md b/docs/types/classes/_metadata_modules_.modulemetadata.md index 46d279ebec..08d25e4396 100644 --- a/docs/types/classes/_metadata_modules_.modulemetadata.md +++ b/docs/types/classes/_metadata_modules_.modulemetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Modules.ts:102](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L102)* +*Defined in [Metadata/Modules.ts:102](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L102)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -60,7 +60,7 @@ ___ getcall(): [CallMetadata](_metadata_modules_.callmetadata.md) -*Defined in [Metadata/Modules.ts:113](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L113)* +*Defined in [Metadata/Modules.ts:113](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L113)* *__description__*: The calls as [CallMetadata](_metadata_modules_.callmetadata.md) @@ -75,7 +75,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -88,7 +88,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/Modules.ts:120](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L120)* +*Defined in [Metadata/Modules.ts:120](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L120)* *__description__*: The name @@ -108,7 +108,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -129,7 +129,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -150,7 +150,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -167,7 +167,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -184,7 +184,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -201,7 +201,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -216,7 +216,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -237,7 +237,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_modules_.runtimemodulemetadata.md b/docs/types/classes/_metadata_modules_.runtimemodulemetadata.md index 629090bdab..79c30b39b6 100644 --- a/docs/types/classes/_metadata_modules_.runtimemodulemetadata.md +++ b/docs/types/classes/_metadata_modules_.runtimemodulemetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Modules.ts:271](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L271)* +*Defined in [Metadata/Modules.ts:271](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L271)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -62,7 +62,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -75,7 +75,7 @@ ___ getmodule(): [ModuleMetadata](_metadata_modules_.modulemetadata.md) -*Defined in [Metadata/Modules.ts:283](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L283)* +*Defined in [Metadata/Modules.ts:283](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L283)* *__description__*: The [ModuleMetadata](_metadata_modules_.modulemetadata.md) @@ -88,7 +88,7 @@ ___ getprefix(): [Text](_text_.text.md) -*Defined in [Metadata/Modules.ts:290](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L290)* +*Defined in [Metadata/Modules.ts:290](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L290)* *__description__*: The prefix @@ -101,7 +101,7 @@ ___ getstorage(): [Option](_codec_option_.option.md)<[StorageMetadata](_metadata_modules_.storagemetadata.md)> -*Defined in [Metadata/Modules.ts:297](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L297)* +*Defined in [Metadata/Modules.ts:297](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L297)* *__description__*: The optional [StorageMetadata](_metadata_modules_.storagemetadata.md) @@ -121,7 +121,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -142,7 +142,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -163,7 +163,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -180,7 +180,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -197,7 +197,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -214,7 +214,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -229,7 +229,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -250,7 +250,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_modules_.storagefunctionmetadata.md b/docs/types/classes/_metadata_modules_.storagefunctionmetadata.md index 7ba088f449..888c2ef262 100644 --- a/docs/types/classes/_metadata_modules_.storagefunctionmetadata.md +++ b/docs/types/classes/_metadata_modules_.storagefunctionmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Modules.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L201)* +*Defined in [Metadata/Modules.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L201)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -60,7 +60,7 @@ ___ getdefault(): [Bytes](_bytes_.bytes.md) -*Defined in [Metadata/Modules.ts:215](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L215)* +*Defined in [Metadata/Modules.ts:215](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L215)* *__description__*: The default value of the storage function @@ -73,7 +73,7 @@ ___ getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> -*Defined in [Metadata/Modules.ts:222](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L222)* +*Defined in [Metadata/Modules.ts:222](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L222)* *__description__*: The [Text](_text_.text.md) documentation @@ -88,7 +88,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -101,7 +101,7 @@ ___ getmodifier(): [StorageFunctionModifier](_metadata_modules_.storagefunctionmodifier.md) -*Defined in [Metadata/Modules.ts:236](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L236)* +*Defined in [Metadata/Modules.ts:236](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L236)* *__description__*: The modifier @@ -114,7 +114,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/Modules.ts:229](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L229)* +*Defined in [Metadata/Modules.ts:229](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L229)* *__description__*: The key name @@ -127,7 +127,7 @@ ___ gettype(): [StorageFunctionType](_metadata_modules_.storagefunctiontype.md) -*Defined in [Metadata/Modules.ts:243](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L243)* +*Defined in [Metadata/Modules.ts:243](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L243)* *__description__*: The [StorageFunctionType](_metadata_modules_.storagefunctiontype.md) @@ -147,7 +147,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -168,7 +168,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -189,7 +189,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -206,7 +206,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -223,7 +223,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -240,7 +240,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -255,7 +255,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -276,7 +276,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_modules_.storagefunctionmodifier.md b/docs/types/classes/_metadata_modules_.storagefunctionmodifier.md index d62edabfa9..5d713d2e8a 100644 --- a/docs/types/classes/_metadata_modules_.storagefunctionmodifier.md +++ b/docs/types/classes/_metadata_modules_.storagefunctionmodifier.md @@ -20,7 +20,7 @@ *Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* -*Defined in [Metadata/Modules.ts:125](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L125)* +*Defined in [Metadata/Modules.ts:125](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L125)* **Parameters:** @@ -42,7 +42,7 @@ getencodedLength(): `number` *Inherited from [Enum](_codec_enum_.enum.md).[encodedLength](_codec_enum_.enum.md#encodedlength)* -*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L64)* +*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -62,7 +62,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toHex](_codec_enum_.enum.md#tohex)* -*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L71)* +*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L71)* *__description__*: Returns a hex string representation of the value @@ -79,7 +79,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toJSON](_codec_enum_.enum.md#tojson)* -*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L78)* +*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L78)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -94,7 +94,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* -*Defined in [codec/Enum.ts:85](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L85)* +*Defined in [codec/Enum.ts:85](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L85)* *__description__*: Returns the number representation for the value @@ -111,7 +111,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toString](_codec_enum_.enum.md#tostring)* -*Defined in [codec/Enum.ts:92](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L92)* +*Defined in [codec/Enum.ts:92](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L92)* *__description__*: Returns the string representation of the value @@ -126,7 +126,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toU8a](_codec_enum_.enum.md#tou8a)* -*Defined in [codec/Enum.ts:100](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L100)* +*Defined in [codec/Enum.ts:100](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L100)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -147,7 +147,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[decodeEnum](_codec_enum_.enum.md#decodeenum)* -*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L47)* +*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L47)* **Parameters:** diff --git a/docs/types/classes/_metadata_modules_.storagefunctiontype.md b/docs/types/classes/_metadata_modules_.storagefunctiontype.md index ce6d5aa4f8..c02173485d 100644 --- a/docs/types/classes/_metadata_modules_.storagefunctiontype.md +++ b/docs/types/classes/_metadata_modules_.storagefunctiontype.md @@ -20,7 +20,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [Metadata/Modules.ts:154](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L154)* +*Defined in [Metadata/Modules.ts:154](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L154)* **Parameters:** @@ -41,7 +41,7 @@ ___ getasMap(): [StorageFunctionType$Map](_metadata_modules_.storagefunctiontype_map.md) -*Defined in [Metadata/Modules.ts:172](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L172)* +*Defined in [Metadata/Modules.ts:172](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L172)* *__description__*: The value as a mapped value @@ -54,7 +54,7 @@ ___ getasType(): [Type](_type_.type.md) -*Defined in [Metadata/Modules.ts:179](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L179)* +*Defined in [Metadata/Modules.ts:179](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L179)* *__description__*: The value as a \[\[Type\]\] value @@ -69,7 +69,7 @@ getencodedLength(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* -*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L97)* +*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L97)* *__description__*: The length of the value when encoded as a Uint8Array @@ -82,7 +82,7 @@ ___ getisMap(): `boolean` -*Defined in [Metadata/Modules.ts:165](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L165)* +*Defined in [Metadata/Modules.ts:165](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L165)* *__description__*: `true` if the storage entry is a map @@ -97,7 +97,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L104)* +*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L104)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type @@ -112,7 +112,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L111)* +*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L111)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone) @@ -127,7 +127,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L118)* +*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L118)* *__description__*: The name of the type this enum value represents @@ -142,7 +142,7 @@ getvalue(): [Codec](../interfaces/_types_.codec.md) *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L125)* +*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L125)* *__description__*: The value of the enum @@ -162,7 +162,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L132)* +*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L132)* *__description__*: Returns a hex string representation of the value @@ -179,7 +179,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L139)* +*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L139)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -194,7 +194,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L146)* +*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L146)* *__description__*: Returns the number representation for the value @@ -211,7 +211,7 @@ ___ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [Metadata/Modules.ts:186](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L186)* +*Defined in [Metadata/Modules.ts:186](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L186)* *__description__*: Returns the string representation of the value @@ -226,7 +226,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L161)* +*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L161)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_metadata_modules_.storagefunctiontype_map.md b/docs/types/classes/_metadata_modules_.storagefunctiontype_map.md index 2295f30bb0..f6e39f7dae 100644 --- a/docs/types/classes/_metadata_modules_.storagefunctiontype_map.md +++ b/docs/types/classes/_metadata_modules_.storagefunctiontype_map.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Modules.ts:131](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L131)* +*Defined in [Metadata/Modules.ts:131](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L131)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -62,7 +62,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -75,7 +75,7 @@ ___ getkey(): [Type](_type_.type.md) -*Defined in [Metadata/Modules.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L142)* +*Defined in [Metadata/Modules.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L142)* *__description__*: The mapped key as [Type](_metadata_modules_.storagefunctiontype_map.md#type) @@ -88,7 +88,7 @@ ___ getvalue(): [Type](_type_.type.md) -*Defined in [Metadata/Modules.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L149)* +*Defined in [Metadata/Modules.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L149)* *__description__*: The mapped value as [Type](_metadata_modules_.storagefunctiontype_map.md#type) @@ -108,7 +108,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -129,7 +129,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -150,7 +150,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -167,7 +167,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -184,7 +184,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -201,7 +201,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -216,7 +216,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -237,7 +237,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_modules_.storagemetadata.md b/docs/types/classes/_metadata_modules_.storagemetadata.md index f0b22267bf..61b8ae28e4 100644 --- a/docs/types/classes/_metadata_modules_.storagemetadata.md +++ b/docs/types/classes/_metadata_modules_.storagemetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Modules.ts:248](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L248)* +*Defined in [Metadata/Modules.ts:248](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L248)* **Parameters:** @@ -47,7 +47,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -62,7 +62,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -75,7 +75,7 @@ ___ getfunctions(): [Vector](_codec_vector_.vector.md)<[StorageFunctionMetadata](_metadata_modules_.storagefunctionmetadata.md)> -*Defined in [Metadata/Modules.ts:259](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L259)* +*Defined in [Metadata/Modules.ts:259](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L259)* *__description__*: The [StorageFunctionMetadata](_metadata_modules_.storagefunctionmetadata.md) for the section @@ -88,7 +88,7 @@ ___ getprefix(): [Text](_text_.text.md) -*Defined in [Metadata/Modules.ts:266](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Metadata/Modules.ts#L266)* +*Defined in [Metadata/Modules.ts:266](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Metadata/Modules.ts#L266)* *__description__*: The section prefix @@ -108,7 +108,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -129,7 +129,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -150,7 +150,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -167,7 +167,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -184,7 +184,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -201,7 +201,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -216,7 +216,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -237,7 +237,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_method_.method.html b/docs/types/classes/_method_.method.html index f2c367ca6b..f979637adb 100644 --- a/docs/types/classes/_method_.method.html +++ b/docs/types/classes/_method_.method.html @@ -2006,7 +2006,7 @@

constructor

⊕ new Method(value: any, meta?: FunctionMetadata): Method

Overrides Struct.constructor

-

Defined in Method.ts:70

+

Defined in Method.ts:70

Parameters:

@@ -2033,35 +2033,35 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


args

getargs(): Array<Codec>

-

Defined in Method.ts:192

+

Defined in Method.ts:192

description: The arguments for the function call

Returns: Array<Codec>


argsDef

getargsDef(): ArgsDef

-

Defined in Method.ts:200

+

Defined in Method.ts:200

description: Thge argument defintions

Returns: ArgsDef


callIndex

getcallIndex(): Uint8Array

-

Defined in Method.ts:207

+

Defined in Method.ts:207

description: The encoded [sectionIndex, methodIndex] identifier

Returns: Uint8Array


data

getdata(): Uint8Array

-

Defined in Method.ts:214

+

Defined in Method.ts:214

description: The encoded data

Returns: Uint8Array


@@ -2069,21 +2069,21 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


hasOrigin

gethasOrigin(): boolean

-

Defined in Method.ts:221

+

Defined in Method.ts:221

description: true if the Origin type is on the method (extrinsic method)

Returns: boolean


meta

getmeta(): FunctionMetadata

-

Defined in Method.ts:230

+

Defined in Method.ts:230

description: The FunctionMetadata

Returns: FunctionMetadata


@@ -2093,7 +2093,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2118,7 +2118,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2141,7 +2141,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2150,7 +2150,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2159,7 +2159,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2168,7 +2168,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2176,7 +2176,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2202,7 +2202,7 @@

<Static> filterOrigin

▸ filterOrigin(meta?: FunctionMetadata): Array<FunctionArgumentMetadata>

-

Defined in Method.ts:140

+

Defined in Method.ts:140

Parameters:

@@ -2223,7 +2223,7 @@

<Static> findFunction

▸ findFunction(callIndex: Uint8Array): MethodFunction

-

Defined in Method.ts:156

+

Defined in Method.ts:156

Parameters:

@@ -2244,7 +2244,7 @@

<Static> injectMethods

▸ injectMethods(moduleMethods: ModulesWithMethods): void

-

Defined in Method.ts:181

+

Defined in Method.ts:181

Parameters:

@@ -2266,7 +2266,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2329,7 +2329,7 @@ diff --git a/docs/types/classes/_method_.method.md b/docs/types/classes/_method_.method.md index 7381a1b344..4494bb1812 100644 --- a/docs/types/classes/_method_.method.md +++ b/docs/types/classes/_method_.method.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Method.ts:70](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L70)* +*Defined in [Method.ts:70](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L70)* **Parameters:** @@ -54,7 +54,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -67,7 +67,7 @@ ___ getargs(): `Array`<[Codec](../interfaces/_types_.codec.md)> -*Defined in [Method.ts:192](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L192)* +*Defined in [Method.ts:192](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L192)* *__description__*: The arguments for the function call @@ -80,7 +80,7 @@ ___ getargsDef(): `ArgsDef` -*Defined in [Method.ts:200](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L200)* +*Defined in [Method.ts:200](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L200)* *__description__*: Thge argument defintions @@ -93,7 +93,7 @@ ___ getcallIndex(): `Uint8Array` -*Defined in [Method.ts:207](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L207)* +*Defined in [Method.ts:207](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L207)* *__description__*: The encoded `[sectionIndex, methodIndex]` identifier @@ -106,7 +106,7 @@ ___ getdata(): `Uint8Array` -*Defined in [Method.ts:214](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L214)* +*Defined in [Method.ts:214](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L214)* *__description__*: The encoded data @@ -121,7 +121,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -134,7 +134,7 @@ ___ gethasOrigin(): `boolean` -*Defined in [Method.ts:221](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L221)* +*Defined in [Method.ts:221](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L221)* *__description__*: `true` if the `Origin` type is on the method (extrinsic method) @@ -147,7 +147,7 @@ ___ getmeta(): [FunctionMetadata](_metadata_modules_.functionmetadata.md) -*Defined in [Method.ts:230](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L230)* +*Defined in [Method.ts:230](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L230)* *__description__*: The [FunctionMetadata](_metadata_modules_.functionmetadata.md) @@ -167,7 +167,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -188,7 +188,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -209,7 +209,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -226,7 +226,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -243,7 +243,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -260,7 +260,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -275,7 +275,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -294,7 +294,7 @@ ___ ▸ **filterOrigin**(meta?: *[FunctionMetadata](_metadata_modules_.functionmetadata.md)*): `Array`<[FunctionArgumentMetadata](_metadata_modules_.functionargumentmetadata.md)> -*Defined in [Method.ts:140](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L140)* +*Defined in [Method.ts:140](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L140)* **Parameters:** @@ -311,7 +311,7 @@ ___ ▸ **findFunction**(callIndex: *`Uint8Array`*): [MethodFunction](../interfaces/_method_.methodfunction.md) -*Defined in [Method.ts:156](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L156)* +*Defined in [Method.ts:156](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L156)* **Parameters:** @@ -328,7 +328,7 @@ ___ ▸ **injectMethods**(moduleMethods: *[ModulesWithMethods](../interfaces/_method_.moduleswithmethods.md)*): `void` -*Defined in [Method.ts:181](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L181)* +*Defined in [Method.ts:181](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L181)* **Parameters:** @@ -347,7 +347,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_method_.methodindex.html b/docs/types/classes/_method_.methodindex.html index ab49e0559d..2af8dd77f1 100644 --- a/docs/types/classes/_method_.methodindex.html +++ b/docs/types/classes/_method_.methodindex.html @@ -2002,7 +2002,7 @@

constructor

⊕ new MethodIndex(value?: AnyU8a): MethodIndex

Overrides U8aFixed.constructor

-

Defined in Method.ts:57

+

Defined in Method.ts:57

Parameters:

@@ -2025,7 +2025,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2034,7 +2034,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2043,7 +2043,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2052,7 +2052,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2084,7 +2084,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2093,7 +2093,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2103,7 +2103,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2111,7 +2111,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2177,7 +2177,7 @@ diff --git a/docs/types/classes/_method_.methodindex.md b/docs/types/classes/_method_.methodindex.md index 04ad0cfbe5..1c5871b3aa 100644 --- a/docs/types/classes/_method_.methodindex.md +++ b/docs/types/classes/_method_.methodindex.md @@ -27,7 +27,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [Method.ts:57](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L57)* +*Defined in [Method.ts:57](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L57)* **Parameters:** @@ -49,7 +49,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -84,7 +84,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -101,7 +101,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -125,7 +125,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -142,7 +142,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -161,7 +161,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -176,7 +176,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_misbehaviorreport_.bftatreport.html b/docs/types/classes/_misbehaviorreport_.bftatreport.html index 829af76354..c95e231c70 100644 --- a/docs/types/classes/_misbehaviorreport_.bftatreport.html +++ b/docs/types/classes/_misbehaviorreport_.bftatreport.html @@ -2008,7 +2008,7 @@

constructor

⊕ new BftAtReport(value?: BftAtReportValue | Uint8Array): BftAtReport

Overrides Struct.constructor

-

Defined in MisbehaviorReport.ts:33

+

Defined in MisbehaviorReport.ts:33

Parameters:

@@ -2032,21 +2032,21 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


a

geta(): BftHashSignature

-

Defined in MisbehaviorReport.ts:45

+

Defined in MisbehaviorReport.ts:45

description: The first report BftHashSignature

Returns: BftHashSignature


b

getb(): BftHashSignature

-

Defined in MisbehaviorReport.ts:52

+

Defined in MisbehaviorReport.ts:52

description: The second report BftHashSignature

Returns: BftHashSignature


@@ -2054,14 +2054,14 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


round

getround(): U32

-

Defined in MisbehaviorReport.ts:59

+

Defined in MisbehaviorReport.ts:59

description: The round this report applies to as U32

Returns: U32


@@ -2071,7 +2071,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2096,7 +2096,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2119,7 +2119,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2128,7 +2128,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2137,7 +2137,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2146,7 +2146,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2154,7 +2154,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2181,7 +2181,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2244,7 +2244,7 @@ diff --git a/docs/types/classes/_misbehaviorreport_.bftatreport.md b/docs/types/classes/_misbehaviorreport_.bftatreport.md index f0dfbd8b10..742a5bd111 100644 --- a/docs/types/classes/_misbehaviorreport_.bftatreport.md +++ b/docs/types/classes/_misbehaviorreport_.bftatreport.md @@ -35,7 +35,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L33)* +*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L33)* **Parameters:** @@ -57,7 +57,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -70,7 +70,7 @@ ___ geta(): [BftHashSignature](_bft_.bfthashsignature.md) -*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L45)* +*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L45)* *__description__*: The first report [BftHashSignature](_bft_.bfthashsignature.md) @@ -83,7 +83,7 @@ ___ getb(): [BftHashSignature](_bft_.bfthashsignature.md) -*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L52)* +*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L52)* *__description__*: The second report [BftHashSignature](_bft_.bfthashsignature.md) @@ -98,7 +98,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -111,7 +111,7 @@ ___ getround(): [U32](_u32_.u32.md) -*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L59)* +*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L59)* *__description__*: The round this report applies to as [U32](_u32_.u32.md) @@ -131,7 +131,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -152,7 +152,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -173,7 +173,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -190,7 +190,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -207,7 +207,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -224,7 +224,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -239,7 +239,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -260,7 +260,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.bftdoublecommit.html b/docs/types/classes/_misbehaviorreport_.bftdoublecommit.html index 072f881427..276c993261 100644 --- a/docs/types/classes/_misbehaviorreport_.bftdoublecommit.html +++ b/docs/types/classes/_misbehaviorreport_.bftdoublecommit.html @@ -2006,7 +2006,7 @@

⊕ new BftDoubleCommit(value?: BftAtReportValue | Uint8Array): BftDoubleCommit

Inherited from BftAtReport.constructor

Overrides Struct.constructor

-

Defined in MisbehaviorReport.ts:33

+

Defined in MisbehaviorReport.ts:33

Parameters:

@@ -2030,7 +2030,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2038,7 +2038,7 @@

a

geta(): BftHashSignature

Inherited from BftAtReport.a

-

Defined in MisbehaviorReport.ts:45

+

Defined in MisbehaviorReport.ts:45

description: The first report BftHashSignature

Returns: BftHashSignature


@@ -2046,7 +2046,7 @@

b

getb(): BftHashSignature

Inherited from BftAtReport.b

-

Defined in MisbehaviorReport.ts:52

+

Defined in MisbehaviorReport.ts:52

description: The second report BftHashSignature

Returns: BftHashSignature


@@ -2054,7 +2054,7 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2062,7 +2062,7 @@

round

getround(): U32

Inherited from BftAtReport.round

-

Defined in MisbehaviorReport.ts:59

+

Defined in MisbehaviorReport.ts:59

description: The round this report applies to as U32

Returns: U32


@@ -2072,7 +2072,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2097,7 +2097,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2120,7 +2120,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2129,7 +2129,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2138,7 +2138,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2147,7 +2147,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2155,7 +2155,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2182,7 +2182,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2245,7 +2245,7 @@ diff --git a/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md b/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md index b1dcdd109f..f5e0ba9869 100644 --- a/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md +++ b/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L33)* +*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L33)* **Parameters:** @@ -53,7 +53,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -68,7 +68,7 @@ geta(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[a](_misbehaviorreport_.bftatreport.md#a)* -*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L45)* +*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L45)* *__description__*: The first report [BftHashSignature](_bft_.bfthashsignature.md) @@ -83,7 +83,7 @@ getb(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[b](_misbehaviorreport_.bftatreport.md#b)* -*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L52)* +*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L52)* *__description__*: The second report [BftHashSignature](_bft_.bfthashsignature.md) @@ -98,7 +98,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -113,7 +113,7 @@ getround(): [U32](_u32_.u32.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[round](_misbehaviorreport_.bftatreport.md#round)* -*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L59)* +*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L59)* *__description__*: The round this report applies to as [U32](_u32_.u32.md) @@ -133,7 +133,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -154,7 +154,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -175,7 +175,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -192,7 +192,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -209,7 +209,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -226,7 +226,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -241,7 +241,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -262,7 +262,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.html b/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.html index d5ea318624..fa5f610362 100644 --- a/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.html +++ b/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.html @@ -2006,7 +2006,7 @@

⊕ new BftDoublePrepare(value?: BftAtReportValue | Uint8Array): BftDoublePrepare

Inherited from BftAtReport.constructor

Overrides Struct.constructor

-

Defined in MisbehaviorReport.ts:33

+

Defined in MisbehaviorReport.ts:33

Parameters:

@@ -2030,7 +2030,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2038,7 +2038,7 @@

a

geta(): BftHashSignature

Inherited from BftAtReport.a

-

Defined in MisbehaviorReport.ts:45

+

Defined in MisbehaviorReport.ts:45

description: The first report BftHashSignature

Returns: BftHashSignature


@@ -2046,7 +2046,7 @@

b

getb(): BftHashSignature

Inherited from BftAtReport.b

-

Defined in MisbehaviorReport.ts:52

+

Defined in MisbehaviorReport.ts:52

description: The second report BftHashSignature

Returns: BftHashSignature


@@ -2054,7 +2054,7 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2062,7 +2062,7 @@

round

getround(): U32

Inherited from BftAtReport.round

-

Defined in MisbehaviorReport.ts:59

+

Defined in MisbehaviorReport.ts:59

description: The round this report applies to as U32

Returns: U32


@@ -2072,7 +2072,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2097,7 +2097,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2120,7 +2120,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2129,7 +2129,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2138,7 +2138,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2147,7 +2147,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2155,7 +2155,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2182,7 +2182,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2245,7 +2245,7 @@ diff --git a/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md b/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md index f519edd47e..815e98b5d9 100644 --- a/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md +++ b/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L33)* +*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L33)* **Parameters:** @@ -53,7 +53,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -68,7 +68,7 @@ geta(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[a](_misbehaviorreport_.bftatreport.md#a)* -*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L45)* +*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L45)* *__description__*: The first report [BftHashSignature](_bft_.bfthashsignature.md) @@ -83,7 +83,7 @@ getb(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[b](_misbehaviorreport_.bftatreport.md#b)* -*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L52)* +*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L52)* *__description__*: The second report [BftHashSignature](_bft_.bfthashsignature.md) @@ -98,7 +98,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -113,7 +113,7 @@ getround(): [U32](_u32_.u32.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[round](_misbehaviorreport_.bftatreport.md#round)* -*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L59)* +*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L59)* *__description__*: The round this report applies to as [U32](_u32_.u32.md) @@ -133,7 +133,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -154,7 +154,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -175,7 +175,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -192,7 +192,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -209,7 +209,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -226,7 +226,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -241,7 +241,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -262,7 +262,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.bftdoublepropose.html b/docs/types/classes/_misbehaviorreport_.bftdoublepropose.html index e648fd1521..49d091341f 100644 --- a/docs/types/classes/_misbehaviorreport_.bftdoublepropose.html +++ b/docs/types/classes/_misbehaviorreport_.bftdoublepropose.html @@ -2006,7 +2006,7 @@

⊕ new BftDoublePropose(value?: BftAtReportValue | Uint8Array): BftDoublePropose

Inherited from BftAtReport.constructor

Overrides Struct.constructor

-

Defined in MisbehaviorReport.ts:33

+

Defined in MisbehaviorReport.ts:33

Parameters:

@@ -2030,7 +2030,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2038,7 +2038,7 @@

a

geta(): BftHashSignature

Inherited from BftAtReport.a

-

Defined in MisbehaviorReport.ts:45

+

Defined in MisbehaviorReport.ts:45

description: The first report BftHashSignature

Returns: BftHashSignature


@@ -2046,7 +2046,7 @@

b

getb(): BftHashSignature

Inherited from BftAtReport.b

-

Defined in MisbehaviorReport.ts:52

+

Defined in MisbehaviorReport.ts:52

description: The second report BftHashSignature

Returns: BftHashSignature


@@ -2054,7 +2054,7 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2062,7 +2062,7 @@

round

getround(): U32

Inherited from BftAtReport.round

-

Defined in MisbehaviorReport.ts:59

+

Defined in MisbehaviorReport.ts:59

description: The round this report applies to as U32

Returns: U32


@@ -2072,7 +2072,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2097,7 +2097,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2120,7 +2120,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2129,7 +2129,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2138,7 +2138,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2147,7 +2147,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2155,7 +2155,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2182,7 +2182,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2245,7 +2245,7 @@ diff --git a/docs/types/classes/_misbehaviorreport_.bftdoublepropose.md b/docs/types/classes/_misbehaviorreport_.bftdoublepropose.md index 5c99875a00..7bbf730459 100644 --- a/docs/types/classes/_misbehaviorreport_.bftdoublepropose.md +++ b/docs/types/classes/_misbehaviorreport_.bftdoublepropose.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L33)* +*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L33)* **Parameters:** @@ -53,7 +53,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -68,7 +68,7 @@ geta(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[a](_misbehaviorreport_.bftatreport.md#a)* -*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L45)* +*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L45)* *__description__*: The first report [BftHashSignature](_bft_.bfthashsignature.md) @@ -83,7 +83,7 @@ getb(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[b](_misbehaviorreport_.bftatreport.md#b)* -*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L52)* +*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L52)* *__description__*: The second report [BftHashSignature](_bft_.bfthashsignature.md) @@ -98,7 +98,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -113,7 +113,7 @@ getround(): [U32](_u32_.u32.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[round](_misbehaviorreport_.bftatreport.md#round)* -*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L59)* +*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L59)* *__description__*: The round this report applies to as [U32](_u32_.u32.md) @@ -133,7 +133,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -154,7 +154,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -175,7 +175,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -192,7 +192,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -209,7 +209,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -226,7 +226,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -241,7 +241,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -262,7 +262,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.html b/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.html index 4fdc5ef206..ad037356b0 100644 --- a/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.html +++ b/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.html @@ -2005,7 +2005,7 @@

constructor

⊕ new BftProposeOutOfTurn(value?: BftAtReportValue | Uint8Array): BftProposeOutOfTurn

Overrides Struct.constructor

-

Defined in MisbehaviorReport.ts:69

+

Defined in MisbehaviorReport.ts:69

Parameters:

@@ -2029,14 +2029,14 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


a

geta(): BftHashSignature

-

Defined in MisbehaviorReport.ts:80

+

Defined in MisbehaviorReport.ts:80

description: The BftHashSignature the report applies to

Returns: BftHashSignature


@@ -2044,14 +2044,14 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


round

getround(): U32

-

Defined in MisbehaviorReport.ts:87

+

Defined in MisbehaviorReport.ts:87

description: The round as [[u32]]

Returns: U32


@@ -2061,7 +2061,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2086,7 +2086,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2109,7 +2109,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2118,7 +2118,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2127,7 +2127,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2136,7 +2136,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2144,7 +2144,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2171,7 +2171,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2234,7 +2234,7 @@ diff --git a/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.md b/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.md index 7243c47b85..8b951261fb 100644 --- a/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.md +++ b/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:69](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L69)* +*Defined in [MisbehaviorReport.ts:69](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L69)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -64,7 +64,7 @@ ___ geta(): [BftHashSignature](_bft_.bfthashsignature.md) -*Defined in [MisbehaviorReport.ts:80](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L80)* +*Defined in [MisbehaviorReport.ts:80](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L80)* *__description__*: The [BftHashSignature](_bft_.bfthashsignature.md) the report applies to @@ -79,7 +79,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -92,7 +92,7 @@ ___ getround(): [U32](_u32_.u32.md) -*Defined in [MisbehaviorReport.ts:87](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L87)* +*Defined in [MisbehaviorReport.ts:87](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L87)* *__description__*: The round as \[\[u32\]\] @@ -112,7 +112,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -133,7 +133,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -154,7 +154,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -171,7 +171,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -188,7 +188,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -205,7 +205,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -220,7 +220,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -241,7 +241,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.misbehaviorkind.html b/docs/types/classes/_misbehaviorreport_.misbehaviorkind.html index 7851616aac..c2c9dba320 100644 --- a/docs/types/classes/_misbehaviorreport_.misbehaviorkind.html +++ b/docs/types/classes/_misbehaviorreport_.misbehaviorkind.html @@ -2000,7 +2000,7 @@

constructor

⊕ new MisbehaviorKind(value?: BftAtReportValue | Uint8Array, index?: undefined | number): MisbehaviorKind

Overrides EnumType.constructor

-

Defined in MisbehaviorReport.ts:121

+

Defined in MisbehaviorReport.ts:121

Parameters:

@@ -2029,7 +2029,7 @@

encodedLength

getencodedLength(): number

Inherited from EnumType.encodedLength

-

Defined in codec/EnumType.ts:97

+

Defined in codec/EnumType.ts:97

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2037,7 +2037,7 @@

isNone

getisNone(): boolean

Inherited from EnumType.isNone

-

Defined in codec/EnumType.ts:104

+

Defined in codec/EnumType.ts:104

description: Checks if the Enum points to a Null type

Returns: boolean


@@ -2045,7 +2045,7 @@

isNull

getisNull(): boolean

Inherited from EnumType.isNull

-

Defined in codec/EnumType.ts:111

+

Defined in codec/EnumType.ts:111

description: Checks if the Enum points to a Null type (deprecated, use isNone)

Returns: boolean


@@ -2053,7 +2053,7 @@

type

gettype(): string

Inherited from EnumType.type

-

Defined in codec/EnumType.ts:118

+

Defined in codec/EnumType.ts:118

description: The name of the type this enum value represents

Returns: string


@@ -2061,7 +2061,7 @@

value

getvalue(): Codec

Inherited from EnumType.value

-

Defined in codec/EnumType.ts:125

+

Defined in codec/EnumType.ts:125

description: The value of the enum

Returns: Codec


@@ -2071,7 +2071,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from EnumType.toHex

-

Defined in codec/EnumType.ts:132

+

Defined in codec/EnumType.ts:132

description: Returns a hex string representation of the value

Returns: string


@@ -2080,7 +2080,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from EnumType.toJSON

-

Defined in codec/EnumType.ts:139

+

Defined in codec/EnumType.ts:139

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2088,7 +2088,7 @@

toNumber

▸ toNumber(): number

Inherited from EnumType.toNumber

-

Defined in codec/EnumType.ts:146

+

Defined in codec/EnumType.ts:146

description: Returns the number representation for the value

Returns: number


@@ -2097,7 +2097,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from EnumType.toString

-

Defined in codec/EnumType.ts:153

+

Defined in codec/EnumType.ts:153

description: Returns the string representation of the value

Returns: string


@@ -2105,7 +2105,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from EnumType.toU8a

-

Defined in codec/EnumType.ts:161

+

Defined in codec/EnumType.ts:161

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2171,7 +2171,7 @@ diff --git a/docs/types/classes/_misbehaviorreport_.misbehaviorkind.md b/docs/types/classes/_misbehaviorreport_.misbehaviorkind.md index 278c03aa15..256fdae6f7 100644 --- a/docs/types/classes/_misbehaviorreport_.misbehaviorkind.md +++ b/docs/types/classes/_misbehaviorreport_.misbehaviorkind.md @@ -24,7 +24,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [MisbehaviorReport.ts:121](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L121)* +*Defined in [MisbehaviorReport.ts:121](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L121)* **Parameters:** @@ -47,7 +47,7 @@ getencodedLength(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* -*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L97)* +*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L97)* *__description__*: The length of the value when encoded as a Uint8Array @@ -62,7 +62,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L104)* +*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L104)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type @@ -77,7 +77,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L111)* +*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L111)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone) @@ -92,7 +92,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L118)* +*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L118)* *__description__*: The name of the type this enum value represents @@ -107,7 +107,7 @@ getvalue(): [Codec](../interfaces/_types_.codec.md) *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L125)* +*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L125)* *__description__*: The value of the enum @@ -127,7 +127,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L132)* +*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L132)* *__description__*: Returns a hex string representation of the value @@ -144,7 +144,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L139)* +*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L139)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -159,7 +159,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L146)* +*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L146)* *__description__*: Returns the number representation for the value @@ -176,7 +176,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [codec/EnumType.ts:153](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L153)* +*Defined in [codec/EnumType.ts:153](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L153)* *__description__*: Returns the string representation of the value @@ -191,7 +191,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/EnumType.ts#L161)* +*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/EnumType.ts#L161)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_misbehaviorreport_.misbehaviorreport.html b/docs/types/classes/_misbehaviorreport_.misbehaviorreport.html index 903eee998e..e023abfd4e 100644 --- a/docs/types/classes/_misbehaviorreport_.misbehaviorreport.html +++ b/docs/types/classes/_misbehaviorreport_.misbehaviorreport.html @@ -2005,7 +2005,7 @@

constructor

⊕ new MisbehaviorReport(value?: MisbehaviorReportValue | Uint8Array): MisbehaviorReport

Overrides Struct.constructor

-

Defined in MisbehaviorReport.ts:144

+

Defined in MisbehaviorReport.ts:144

Parameters:

@@ -2029,7 +2029,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2037,35 +2037,35 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


misbehavior

getmisbehavior(): MisbehaviorKind

-

Defined in MisbehaviorReport.ts:157

+

Defined in MisbehaviorReport.ts:157

description: The MisbehaviorKind

Returns: MisbehaviorKind


parentHash

getparentHash(): Hash

-

Defined in MisbehaviorReport.ts:164

+

Defined in MisbehaviorReport.ts:164

description: The Hash of the parent block

Returns: Hash


parentNumber

getparentNumber(): BlockNumber

-

Defined in MisbehaviorReport.ts:171

+

Defined in MisbehaviorReport.ts:171

description: The BlockNumber of the parent

Returns: BlockNumber


target

gettarget(): AuthorityId

-

Defined in MisbehaviorReport.ts:178

+

Defined in MisbehaviorReport.ts:178

description: The authorityId the report applies to

Returns: AuthorityId


@@ -2075,7 +2075,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2100,7 +2100,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2123,7 +2123,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2132,7 +2132,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2141,7 +2141,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2150,7 +2150,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2158,7 +2158,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2185,7 +2185,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2248,7 +2248,7 @@ diff --git a/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md b/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md index ff061464fa..d80f41855d 100644 --- a/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md +++ b/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:144](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L144)* +*Defined in [MisbehaviorReport.ts:144](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L144)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -66,7 +66,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -79,7 +79,7 @@ ___ getmisbehavior(): [MisbehaviorKind](_misbehaviorreport_.misbehaviorkind.md) -*Defined in [MisbehaviorReport.ts:157](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L157)* +*Defined in [MisbehaviorReport.ts:157](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L157)* *__description__*: The [MisbehaviorKind](_misbehaviorreport_.misbehaviorkind.md) @@ -92,7 +92,7 @@ ___ getparentHash(): [Hash](_hash_.hash.md) -*Defined in [MisbehaviorReport.ts:164](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L164)* +*Defined in [MisbehaviorReport.ts:164](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L164)* *__description__*: The [Hash](_hash_.hash.md) of the parent block @@ -105,7 +105,7 @@ ___ getparentNumber(): [BlockNumber](_blocknumber_.blocknumber.md) -*Defined in [MisbehaviorReport.ts:171](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L171)* +*Defined in [MisbehaviorReport.ts:171](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L171)* *__description__*: The [BlockNumber](_blocknumber_.blocknumber.md) of the parent @@ -118,7 +118,7 @@ ___ gettarget(): [AuthorityId](_authorityid_.authorityid.md) -*Defined in [MisbehaviorReport.ts:178](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/MisbehaviorReport.ts#L178)* +*Defined in [MisbehaviorReport.ts:178](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/MisbehaviorReport.ts#L178)* *__description__*: The [authorityId](_bft_.bftauthoritysignature.md#authorityid) the report applies to @@ -138,7 +138,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -159,7 +159,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -180,7 +180,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -197,7 +197,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -214,7 +214,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -231,7 +231,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -246,7 +246,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -267,7 +267,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_moment_.moment.html b/docs/types/classes/_moment_.moment.html index f8c9ff8555..50605300b7 100644 --- a/docs/types/classes/_moment_.moment.html +++ b/docs/types/classes/_moment_.moment.html @@ -1999,7 +1999,7 @@

constructor

⊕ new Moment(value?: Moment | Date | AnyNumber): Moment

-

Defined in Moment.ts:24

+

Defined in Moment.ts:24

Parameters:

@@ -2031,7 +2031,7 @@

encodedLength

getencodedLength(): number

-

Defined in Moment.ts:51

+

Defined in Moment.ts:51

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2039,14 +2039,14 @@

bitLength

▸ bitLength(): UIntBitLength

-

Defined in Moment.ts:58

+

Defined in Moment.ts:58

description: Returns the number of bits in the value

Returns: UIntBitLength


toBn

▸ toBn(): BN

-

Defined in Moment.ts:65

+

Defined in Moment.ts:65

description: Returns the BN representation of the timestamp

Returns: BN


@@ -2054,7 +2054,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in Moment.ts:72

+

Defined in Moment.ts:72

description: Returns a hex string representation of the value

Returns: string


@@ -2063,14 +2063,14 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Overrides Date.toJSON

-

Defined in Moment.ts:79

+

Defined in Moment.ts:79

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


toNumber

▸ toNumber(): number

-

Defined in Moment.ts:86

+

Defined in Moment.ts:86

description: Returns the number representation for the timestamp

Returns: number


@@ -2079,14 +2079,14 @@

▸ toString(): string

Implementation of Codec.toString

Overrides Date.toString

-

Defined in Moment.ts:93

+

Defined in Moment.ts:93

description: Returns the string representation of the value

Returns: string


toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

-

Defined in Moment.ts:102

+

Defined in Moment.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2112,7 +2112,7 @@

<Static> decodeMoment

▸ decodeMoment(value: Moment | Date | AnyNumber): Date

-

Defined in Moment.ts:34

+

Defined in Moment.ts:34

Parameters:

@@ -2175,7 +2175,7 @@ diff --git a/docs/types/classes/_moment_.moment.md b/docs/types/classes/_moment_.moment.md index 6965628a56..08c8c65238 100644 --- a/docs/types/classes/_moment_.moment.md +++ b/docs/types/classes/_moment_.moment.md @@ -22,7 +22,7 @@ ⊕ **new Moment**(value?: *[Moment](_moment_.moment.md) | `Date` | [AnyNumber](../modules/_types_.md#anynumber)*): [Moment](_moment_.moment.md) -*Defined in [Moment.ts:24](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Moment.ts#L24)* +*Defined in [Moment.ts:24](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Moment.ts#L24)* **Parameters:** @@ -54,7 +54,7 @@ ___ getencodedLength(): `number` -*Defined in [Moment.ts:51](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Moment.ts#L51)* +*Defined in [Moment.ts:51](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Moment.ts#L51)* *__description__*: The length of the value when encoded as a Uint8Array @@ -70,7 +70,7 @@ ___ ▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) -*Defined in [Moment.ts:58](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Moment.ts#L58)* +*Defined in [Moment.ts:58](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Moment.ts#L58)* *__description__*: Returns the number of bits in the value @@ -83,7 +83,7 @@ ___ ▸ **toBn**(): `BN` -*Defined in [Moment.ts:65](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Moment.ts#L65)* +*Defined in [Moment.ts:65](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Moment.ts#L65)* *__description__*: Returns the BN representation of the timestamp @@ -98,7 +98,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [Moment.ts:72](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Moment.ts#L72)* +*Defined in [Moment.ts:72](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Moment.ts#L72)* *__description__*: Returns a hex string representation of the value @@ -115,7 +115,7 @@ ___ *Overrides Date.toJSON* -*Defined in [Moment.ts:79](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Moment.ts#L79)* +*Defined in [Moment.ts:79](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Moment.ts#L79)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -128,7 +128,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [Moment.ts:86](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Moment.ts#L86)* +*Defined in [Moment.ts:86](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Moment.ts#L86)* *__description__*: Returns the number representation for the timestamp @@ -145,7 +145,7 @@ ___ *Overrides Date.toString* -*Defined in [Moment.ts:93](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Moment.ts#L93)* +*Defined in [Moment.ts:93](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Moment.ts#L93)* *__description__*: Returns the string representation of the value @@ -158,7 +158,7 @@ ___ ▸ **toU8a**(isBare?: *`undefined` | `false` | `true`*): `Uint8Array` -*Defined in [Moment.ts:102](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Moment.ts#L102)* +*Defined in [Moment.ts:102](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Moment.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -177,7 +177,7 @@ ___ ▸ **decodeMoment**(value: *[Moment](_moment_.moment.md) | `Date` | [AnyNumber](../modules/_types_.md#anynumber)*): `Date` -*Defined in [Moment.ts:34](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Moment.ts#L34)* +*Defined in [Moment.ts:34](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Moment.ts#L34)* **Parameters:** diff --git a/docs/types/classes/_newaccountoutcome_.newaccountoutcome.html b/docs/types/classes/_newaccountoutcome_.newaccountoutcome.html index e40a859c01..c49e228cf6 100644 --- a/docs/types/classes/_newaccountoutcome_.newaccountoutcome.html +++ b/docs/types/classes/_newaccountoutcome_.newaccountoutcome.html @@ -2000,7 +2000,7 @@

constructor

⊕ new NewAccountOutcome(index?: U8a | Uint8Array | number): NewAccountOutcome

Overrides Enum.constructor

-

Defined in NewAccountOutcome.ts:13

+

Defined in NewAccountOutcome.ts:13

Parameters:

@@ -2025,7 +2025,7 @@

encodedLength

getencodedLength(): number

Inherited from Enum.encodedLength

-

Defined in codec/Enum.ts:64

+

Defined in codec/Enum.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2035,7 +2035,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Enum.toHex

-

Defined in codec/Enum.ts:71

+

Defined in codec/Enum.ts:71

description: Returns a hex string representation of the value

Returns: string


@@ -2044,7 +2044,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Enum.toJSON

-

Defined in codec/Enum.ts:78

+

Defined in codec/Enum.ts:78

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2052,7 +2052,7 @@

toNumber

▸ toNumber(): number

Inherited from Enum.toNumber

-

Defined in codec/Enum.ts:85

+

Defined in codec/Enum.ts:85

description: Returns the number representation for the value

Returns: number


@@ -2061,7 +2061,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Enum.toString

-

Defined in codec/Enum.ts:92

+

Defined in codec/Enum.ts:92

description: Returns the string representation of the value

Returns: string


@@ -2069,7 +2069,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Enum.toU8a

-

Defined in codec/Enum.ts:100

+

Defined in codec/Enum.ts:100

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2096,7 +2096,7 @@

<Static> decodeEnum

▸ decodeEnum(def: EnumDef, value: Enum | Uint8Array | string | number): number | undefined

Inherited from Enum.decodeEnum

-

Defined in codec/Enum.ts:47

+

Defined in codec/Enum.ts:47

Parameters:

@@ -2164,7 +2164,7 @@ diff --git a/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md b/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md index b2c462d4bb..37c7edead4 100644 --- a/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md +++ b/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md @@ -24,7 +24,7 @@ *Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* -*Defined in [NewAccountOutcome.ts:13](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/NewAccountOutcome.ts#L13)* +*Defined in [NewAccountOutcome.ts:13](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/NewAccountOutcome.ts#L13)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from [Enum](_codec_enum_.enum.md).[encodedLength](_codec_enum_.enum.md#encodedlength)* -*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L64)* +*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toHex](_codec_enum_.enum.md#tohex)* -*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L71)* +*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L71)* *__description__*: Returns a hex string representation of the value @@ -83,7 +83,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toJSON](_codec_enum_.enum.md#tojson)* -*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L78)* +*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L78)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -98,7 +98,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* -*Defined in [codec/Enum.ts:85](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L85)* +*Defined in [codec/Enum.ts:85](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L85)* *__description__*: Returns the number representation for the value @@ -115,7 +115,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toString](_codec_enum_.enum.md#tostring)* -*Defined in [codec/Enum.ts:92](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L92)* +*Defined in [codec/Enum.ts:92](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L92)* *__description__*: Returns the string representation of the value @@ -130,7 +130,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toU8a](_codec_enum_.enum.md#tou8a)* -*Defined in [codec/Enum.ts:100](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L100)* +*Defined in [codec/Enum.ts:100](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L100)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -151,7 +151,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[decodeEnum](_codec_enum_.enum.md#decodeenum)* -*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L47)* +*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L47)* **Parameters:** diff --git a/docs/types/classes/_nonce_.nonce.html b/docs/types/classes/_nonce_.nonce.html index 757415f6e2..9cc8334ec4 100644 --- a/docs/types/classes/_nonce_.nonce.html +++ b/docs/types/classes/_nonce_.nonce.html @@ -2001,7 +2001,7 @@

⊕ new Nonce(value?: AnyNumber): Nonce

Inherited from U64.constructor

Overrides UInt.constructor

-

Defined in U64.ts:14

+

Defined in U64.ts:14

Parameters:

@@ -2026,7 +2026,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2035,7 +2035,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2101,7 +2101,7 @@ diff --git a/docs/types/classes/_nonce_.nonce.md b/docs/types/classes/_nonce_.nonce.md index a566b235bf..ddb2659642 100644 --- a/docs/types/classes/_nonce_.nonce.md +++ b/docs/types/classes/_nonce_.nonce.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/U64.ts#L14)* +*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/U64.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -69,7 +69,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_noncecompact_.noncecompact.md b/docs/types/classes/_noncecompact_.noncecompact.md index 0665afa829..a6cbe0b64f 100644 --- a/docs/types/classes/_noncecompact_.noncecompact.md +++ b/docs/types/classes/_noncecompact_.noncecompact.md @@ -26,7 +26,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/Compact.ts:23](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L23)* +*Defined in [codec/Compact.ts:23](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L23)* **Parameters:** @@ -49,7 +49,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[addLengthPrefix](_codec_compact_.compact.md#addlengthprefix)* -*Defined in [codec/Compact.ts:41](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L41)* +*Defined in [codec/Compact.ts:41](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L41)* Prepend a Uint8Array with its compact length. *__param__*: The Uint8Array to be prefixed @@ -63,7 +63,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[decodeU8a](_codec_compact_.compact.md#decodeu8a)* -*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L42)* +*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L42)* ___ @@ -74,7 +74,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[encodeU8a](_codec_compact_.compact.md#encodeu8a)* -*Defined in [codec/Compact.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L43)* +*Defined in [codec/Compact.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L43)* ___ @@ -88,7 +88,7 @@ getencodedLength(): `number` *Inherited from [Compact](_codec_compact_.compact.md).[encodedLength](_codec_compact_.compact.md#encodedlength)* -*Defined in [codec/Compact.ts:72](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L72)* +*Defined in [codec/Compact.ts:72](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L72)* *__description__*: The length of the value when encoded as a Uint8Array @@ -106,7 +106,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[bitLength](_codec_compact_.compact.md#bitlength)* -*Defined in [codec/Compact.ts:79](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L79)* +*Defined in [codec/Compact.ts:79](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L79)* *__description__*: Returns the number of bits in the value @@ -121,7 +121,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[toBn](_codec_compact_.compact.md#tobn)* -*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L86)* +*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L86)* *__description__*: Returns the BN representation of the number @@ -138,7 +138,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[toHex](_codec_compact_.compact.md#tohex)* -*Defined in [codec/Compact.ts:93](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L93)* +*Defined in [codec/Compact.ts:93](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L93)* *__description__*: Returns a hex string representation of the value @@ -155,7 +155,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[toJSON](_codec_compact_.compact.md#tojson)* -*Defined in [codec/Compact.ts:100](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L100)* +*Defined in [codec/Compact.ts:100](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L100)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -170,7 +170,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[toNumber](_codec_compact_.compact.md#tonumber)* -*Defined in [codec/Compact.ts:107](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L107)* +*Defined in [codec/Compact.ts:107](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L107)* *__description__*: Returns the number representation for the value @@ -187,7 +187,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[toString](_codec_compact_.compact.md#tostring)* -*Defined in [codec/Compact.ts:114](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L114)* +*Defined in [codec/Compact.ts:114](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L114)* *__description__*: Returns the string representation of the value @@ -202,7 +202,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[toU8a](_codec_compact_.compact.md#tou8a)* -*Defined in [codec/Compact.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L122)* +*Defined in [codec/Compact.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L122)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -223,7 +223,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[decodeCompact](_codec_compact_.compact.md#decodecompact)* -*Defined in [codec/Compact.ts:51](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L51)* +*Defined in [codec/Compact.ts:51](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L51)* **Parameters:** @@ -243,7 +243,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[stripLengthPrefix](_codec_compact_.compact.md#striplengthprefix)* -*Defined in [codec/Compact.ts:45](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L45)* +*Defined in [codec/Compact.ts:45](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L45)* **Parameters:** @@ -263,7 +263,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[with](_codec_compact_.compact.md#with)* -*Defined in [codec/Compact.ts:28](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Compact.ts#L28)* +*Defined in [codec/Compact.ts:28](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Compact.ts#L28)* **Parameters:** diff --git a/docs/types/classes/_null_.null.html b/docs/types/classes/_null_.null.html index deec7f1e99..aa1431aa73 100644 --- a/docs/types/classes/_null_.null.html +++ b/docs/types/classes/_null_.null.html @@ -2004,7 +2004,7 @@

encodedLength

getencodedLength(): number

-

Defined in Null.ts:16

+

Defined in Null.ts:16

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2013,7 +2013,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in Null.ts:23

+

Defined in Null.ts:23

description: Returns a hex string representation of the value

Returns: string


@@ -2021,7 +2021,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in Null.ts:30

+

Defined in Null.ts:30

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2029,14 +2029,14 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in Null.ts:37

+

Defined in Null.ts:37

description: Returns the string representation of the value

Returns: string


toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

-

Defined in Null.ts:45

+

Defined in Null.ts:45

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2102,7 +2102,7 @@ diff --git a/docs/types/classes/_null_.null.md b/docs/types/classes/_null_.null.md index 7904a83976..e5f69f53ac 100644 --- a/docs/types/classes/_null_.null.md +++ b/docs/types/classes/_null_.null.md @@ -32,7 +32,7 @@ getencodedLength(): `number` -*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L16)* +*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L16)* *__description__*: The length of the value when encoded as a Uint8Array @@ -50,7 +50,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L23)* +*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L23)* *__description__*: Returns a hex string representation of the value @@ -65,7 +65,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L30)* +*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L30)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -80,7 +80,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L37)* +*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L37)* *__description__*: Returns the string representation of the value @@ -93,7 +93,7 @@ ___ ▸ **toU8a**(isBare?: *`undefined` | `false` | `true`*): `Uint8Array` -*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L45)* +*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L45)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_origin_.origin.html b/docs/types/classes/_origin_.origin.html index 8a710ac169..0db84024cd 100644 --- a/docs/types/classes/_origin_.origin.html +++ b/docs/types/classes/_origin_.origin.html @@ -1999,7 +1999,7 @@

constructor

⊕ new Origin(): Origin

-

Defined in Origin.ts:13

+

Defined in Origin.ts:13

Returns: Origin


Accessors

@@ -2007,7 +2007,7 @@

encodedLength

getencodedLength(): number

Inherited from Null.encodedLength

-

Defined in Null.ts:16

+

Defined in Null.ts:16

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2017,7 +2017,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Null.toHex

-

Defined in Null.ts:23

+

Defined in Null.ts:23

description: Returns a hex string representation of the value

Returns: string


@@ -2026,7 +2026,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Null.toJSON

-

Defined in Null.ts:30

+

Defined in Null.ts:30

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2035,7 +2035,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Null.toString

-

Defined in Null.ts:37

+

Defined in Null.ts:37

description: Returns the string representation of the value

Returns: string


@@ -2043,7 +2043,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Null.toU8a

-

Defined in Null.ts:45

+

Defined in Null.ts:45

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2109,7 +2109,7 @@ diff --git a/docs/types/classes/_origin_.origin.md b/docs/types/classes/_origin_.origin.md index 1d378ec5ac..47628290f8 100644 --- a/docs/types/classes/_origin_.origin.md +++ b/docs/types/classes/_origin_.origin.md @@ -22,7 +22,7 @@ ⊕ **new Origin**(): [Origin](_origin_.origin.md) -*Defined in [Origin.ts:13](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Origin.ts#L13)* +*Defined in [Origin.ts:13](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Origin.ts#L13)* **Returns:** [Origin](_origin_.origin.md) @@ -38,7 +38,7 @@ getencodedLength(): `number` *Inherited from [Null](_null_.null.md).[encodedLength](_null_.null.md#encodedlength)* -*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L16)* +*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L16)* *__description__*: The length of the value when encoded as a Uint8Array @@ -58,7 +58,7 @@ ___ *Inherited from [Null](_null_.null.md).[toHex](_null_.null.md#tohex)* -*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L23)* +*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L23)* *__description__*: Returns a hex string representation of the value @@ -75,7 +75,7 @@ ___ *Inherited from [Null](_null_.null.md).[toJSON](_null_.null.md#tojson)* -*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L30)* +*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L30)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -92,7 +92,7 @@ ___ *Inherited from [Null](_null_.null.md).[toString](_null_.null.md#tostring)* -*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L37)* +*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L37)* *__description__*: Returns the string representation of the value @@ -107,7 +107,7 @@ ___ *Inherited from [Null](_null_.null.md).[toU8a](_null_.null.md#tou8a)* -*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Null.ts#L45)* +*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Null.ts#L45)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_paraid_.paraid.md b/docs/types/classes/_paraid_.paraid.md index ae8ae8229c..90c256d96b 100644 --- a/docs/types/classes/_paraid_.paraid.md +++ b/docs/types/classes/_paraid_.paraid.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/U32.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -69,7 +69,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_pendingextrinsics_.pendingextrinsics.html b/docs/types/classes/_pendingextrinsics_.pendingextrinsics.html index 391894e74b..0189008e41 100644 --- a/docs/types/classes/_pendingextrinsics_.pendingextrinsics.html +++ b/docs/types/classes/_pendingextrinsics_.pendingextrinsics.html @@ -2004,7 +2004,7 @@

constructor

⊕ new PendingExtrinsics(Type: Constructor<T>, value?: Vector<any> | Uint8Array | string | Array<any>): PendingExtrinsics

Inherited from Vector.constructor

-

Defined in codec/Vector.ts:22

+

Defined in codec/Vector.ts:22

Parameters:

@@ -2037,14 +2037,14 @@

Type

getType(): string

Inherited from Vector.Type

-

Defined in codec/Vector.ts:57

+

Defined in codec/Vector.ts:57

Returns: string


encodedLength

getencodedLength(): number

Inherited from Vector.encodedLength

-

Defined in codec/Vector.ts:64

+

Defined in codec/Vector.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2053,7 +2053,7 @@

getlength(): number

Inherited from Vector.length

Overrides Array.length

-

Defined in codec/Vector.ts:73

+

Defined in codec/Vector.ts:73

description: The length of the value

Returns: number


@@ -2063,7 +2063,7 @@

▸ filter(callbackfn: function, thisArg?: any): Array<T>

Inherited from Vector.filter

Overrides Array.filter

-

Defined in codec/Vector.ts:139

+

Defined in codec/Vector.ts:139

description: Filters the array with the callback

Parameters:

@@ -2094,7 +2094,7 @@

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Vector.map

Overrides Array.map

-

Defined in codec/Vector.ts:148

+

Defined in codec/Vector.ts:148

description: Maps the array with the callback

Type parameters:

U

@@ -2126,7 +2126,7 @@

toArray

▸ toArray(): Array<T>

Inherited from Vector.toArray

-

Defined in codec/Vector.ts:81

+

Defined in codec/Vector.ts:81

description: Converts the Object to an standard JavaScript Array

Returns: Array<T>


@@ -2135,7 +2135,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Vector.toHex

-

Defined in codec/Vector.ts:88

+

Defined in codec/Vector.ts:88

description: Returns a hex string representation of the value

Returns: string


@@ -2144,7 +2144,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Vector.toJSON

-

Defined in codec/Vector.ts:95

+

Defined in codec/Vector.ts:95

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2154,7 +2154,7 @@

Implementation of Codec.toString

Inherited from Vector.toString

Overrides Array.toString

-

Defined in codec/Vector.ts:104

+

Defined in codec/Vector.ts:104

description: Returns the string representation of the value

Returns: string


@@ -2162,7 +2162,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Vector.toU8a

-

Defined in codec/Vector.ts:117

+

Defined in codec/Vector.ts:117

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2189,7 +2189,7 @@

<Static> decodeVector

▸ decodeVector<T>(Type: Constructor<T>, value: Vector<any> | Uint8Array | string | Array<any>): Array<T>

Inherited from Vector.decodeVector

-

Defined in codec/Vector.ts:32

+

Defined in codec/Vector.ts:32

Type parameters:

T : Codec

Parameters:

@@ -2220,7 +2220,7 @@

<Static> with

▸ with<O>(Type: Constructor<O>): Constructor<Vector<O>>

Inherited from Vector.with

-

Defined in codec/Vector.ts:49

+

Defined in codec/Vector.ts:49

Type parameters:

O : Codec

Parameters:

@@ -2283,7 +2283,7 @@ diff --git a/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md b/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md index d1ab116a8f..c924028dbe 100644 --- a/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md +++ b/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md @@ -29,7 +29,7 @@ *Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)* -*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L22)* +*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L22)* **Parameters:** @@ -52,7 +52,7 @@ getType(): `string` *Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* -*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L57)* +*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L57)* **Returns:** `string` @@ -65,7 +65,7 @@ getencodedLength(): `number` *Inherited from [Vector](_codec_vector_.vector.md).[encodedLength](_codec_vector_.vector.md#encodedlength)* -*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L64)* +*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -82,7 +82,7 @@ getlength(): `number` *Overrides Array.length* -*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L73)* +*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L73)* *__description__*: The length of the value @@ -102,7 +102,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L139)* +*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L139)* *__description__*: Filters the array with the callback @@ -126,7 +126,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L148)* +*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L148)* *__description__*: Maps the array with the callback @@ -151,7 +151,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)* -*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L81)* +*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L81)* *__description__*: Converts the Object to an standard JavaScript Array @@ -168,7 +168,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)* -*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L88)* +*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L88)* *__description__*: Returns a hex string representation of the value @@ -185,7 +185,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* -*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L95)* +*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L95)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -204,7 +204,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L104)* +*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L104)* *__description__*: Returns the string representation of the value @@ -219,7 +219,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* -*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L117)* +*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L117)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -240,7 +240,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[decodeVector](_codec_vector_.vector.md#decodevector)* -*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L32)* +*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L32)* **Type parameters:** @@ -263,7 +263,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* -*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Vector.ts#L49)* +*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Vector.ts#L49)* **Type parameters:** diff --git a/docs/types/classes/_perbill_.perbill.html b/docs/types/classes/_perbill_.perbill.html index de78b8a9f2..b7ca5c7aed 100644 --- a/docs/types/classes/_perbill_.perbill.html +++ b/docs/types/classes/_perbill_.perbill.html @@ -2001,7 +2001,7 @@

⊕ new Perbill(value?: AnyNumber): Perbill

Inherited from U32.constructor

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -2026,7 +2026,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2035,7 +2035,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2101,7 +2101,7 @@ diff --git a/docs/types/classes/_perbill_.perbill.md b/docs/types/classes/_perbill_.perbill.md index c7e8b8607a..451f17b5ee 100644 --- a/docs/types/classes/_perbill_.perbill.md +++ b/docs/types/classes/_perbill_.perbill.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/U32.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -69,7 +69,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_permill_.permill.html b/docs/types/classes/_permill_.permill.html index ddcf3efaf9..cbcc4d46bc 100644 --- a/docs/types/classes/_permill_.permill.html +++ b/docs/types/classes/_permill_.permill.html @@ -2001,7 +2001,7 @@

⊕ new Permill(value?: AnyNumber): Permill

Inherited from U32.constructor

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -2026,7 +2026,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2035,7 +2035,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2101,7 +2101,7 @@ diff --git a/docs/types/classes/_permill_.permill.md b/docs/types/classes/_permill_.permill.md index 0350189f49..6afda7f04d 100644 --- a/docs/types/classes/_permill_.permill.md +++ b/docs/types/classes/_permill_.permill.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/U32.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -69,7 +69,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_propindex_.propindex.html b/docs/types/classes/_propindex_.propindex.html index 582bf26bfa..c3ce44e067 100644 --- a/docs/types/classes/_propindex_.propindex.html +++ b/docs/types/classes/_propindex_.propindex.html @@ -2001,7 +2001,7 @@

⊕ new PropIndex(value?: AnyNumber): PropIndex

Inherited from U32.constructor

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -2026,7 +2026,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2035,7 +2035,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2101,7 +2101,7 @@ diff --git a/docs/types/classes/_propindex_.propindex.md b/docs/types/classes/_propindex_.propindex.md index a4d55d1908..d07b6b25bf 100644 --- a/docs/types/classes/_propindex_.propindex.md +++ b/docs/types/classes/_propindex_.propindex.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/U32.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -69,7 +69,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_proposal_.proposal.html b/docs/types/classes/_proposal_.proposal.html index 36c6153225..1aeb7a78e2 100644 --- a/docs/types/classes/_proposal_.proposal.html +++ b/docs/types/classes/_proposal_.proposal.html @@ -2006,7 +2006,7 @@

⊕ new Proposal(value: any, meta?: FunctionMetadata): Proposal

Inherited from Method.constructor

Overrides Struct.constructor

-

Defined in Method.ts:70

+

Defined in Method.ts:70

Parameters:

@@ -2033,7 +2033,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2041,7 +2041,7 @@

args

getargs(): Array<Codec>

Inherited from Method.args

-

Defined in Method.ts:192

+

Defined in Method.ts:192

description: The arguments for the function call

Returns: Array<Codec>


@@ -2049,7 +2049,7 @@

argsDef

getargsDef(): ArgsDef

Inherited from Method.argsDef

-

Defined in Method.ts:200

+

Defined in Method.ts:200

description: Thge argument defintions

Returns: ArgsDef


@@ -2057,7 +2057,7 @@

callIndex

getcallIndex(): Uint8Array

Inherited from Method.callIndex

-

Defined in Method.ts:207

+

Defined in Method.ts:207

description: The encoded [sectionIndex, methodIndex] identifier

Returns: Uint8Array


@@ -2065,7 +2065,7 @@

data

getdata(): Uint8Array

Inherited from Method.data

-

Defined in Method.ts:214

+

Defined in Method.ts:214

description: The encoded data

Returns: Uint8Array


@@ -2073,7 +2073,7 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2081,7 +2081,7 @@

hasOrigin

gethasOrigin(): boolean

Inherited from Method.hasOrigin

-

Defined in Method.ts:221

+

Defined in Method.ts:221

description: true if the Origin type is on the method (extrinsic method)

Returns: boolean


@@ -2089,7 +2089,7 @@

meta

getmeta(): FunctionMetadata

Inherited from Method.meta

-

Defined in Method.ts:230

+

Defined in Method.ts:230

description: The FunctionMetadata

Returns: FunctionMetadata


@@ -2099,7 +2099,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2124,7 +2124,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2147,7 +2147,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2156,7 +2156,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2165,7 +2165,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2174,7 +2174,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2182,7 +2182,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2209,7 +2209,7 @@

<Static> filterOrigin

▸ filterOrigin(meta?: FunctionMetadata): Array<FunctionArgumentMetadata>

Inherited from Method.filterOrigin

-

Defined in Method.ts:140

+

Defined in Method.ts:140

Parameters:

@@ -2231,7 +2231,7 @@

<Static> findFunction

▸ findFunction(callIndex: Uint8Array): MethodFunction

Inherited from Method.findFunction

-

Defined in Method.ts:156

+

Defined in Method.ts:156

Parameters:

@@ -2253,7 +2253,7 @@

<Static> injectMethods

▸ injectMethods(moduleMethods: ModulesWithMethods): void

Inherited from Method.injectMethods

-

Defined in Method.ts:181

+

Defined in Method.ts:181

Parameters:

@@ -2275,7 +2275,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2338,7 +2338,7 @@ diff --git a/docs/types/classes/_proposal_.proposal.md b/docs/types/classes/_proposal_.proposal.md index 432475ab81..8eb0baef54 100644 --- a/docs/types/classes/_proposal_.proposal.md +++ b/docs/types/classes/_proposal_.proposal.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Method.ts:70](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L70)* +*Defined in [Method.ts:70](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L70)* **Parameters:** @@ -54,7 +54,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -69,7 +69,7 @@ getargs(): `Array`<[Codec](../interfaces/_types_.codec.md)> *Inherited from [Method](_method_.method.md).[args](_method_.method.md#args)* -*Defined in [Method.ts:192](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L192)* +*Defined in [Method.ts:192](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L192)* *__description__*: The arguments for the function call @@ -84,7 +84,7 @@ getargsDef(): `ArgsDef` *Inherited from [Method](_method_.method.md).[argsDef](_method_.method.md#argsdef)* -*Defined in [Method.ts:200](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L200)* +*Defined in [Method.ts:200](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L200)* *__description__*: Thge argument defintions @@ -99,7 +99,7 @@ getcallIndex(): `Uint8Array` *Inherited from [Method](_method_.method.md).[callIndex](_method_.method.md#callindex)* -*Defined in [Method.ts:207](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L207)* +*Defined in [Method.ts:207](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L207)* *__description__*: The encoded `[sectionIndex, methodIndex]` identifier @@ -114,7 +114,7 @@ getdata(): `Uint8Array` *Inherited from [Method](_method_.method.md).[data](_method_.method.md#data)* -*Defined in [Method.ts:214](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L214)* +*Defined in [Method.ts:214](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L214)* *__description__*: The encoded data @@ -129,7 +129,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -144,7 +144,7 @@ gethasOrigin(): `boolean` *Inherited from [Method](_method_.method.md).[hasOrigin](_method_.method.md#hasorigin)* -*Defined in [Method.ts:221](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L221)* +*Defined in [Method.ts:221](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L221)* *__description__*: `true` if the `Origin` type is on the method (extrinsic method) @@ -159,7 +159,7 @@ getmeta(): [FunctionMetadata](_metadata_modules_.functionmetadata.md) *Inherited from [Method](_method_.method.md).[meta](_method_.method.md#meta)* -*Defined in [Method.ts:230](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L230)* +*Defined in [Method.ts:230](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L230)* *__description__*: The [FunctionMetadata](_metadata_modules_.functionmetadata.md) @@ -179,7 +179,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -200,7 +200,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -221,7 +221,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -238,7 +238,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -255,7 +255,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -272,7 +272,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -287,7 +287,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -308,7 +308,7 @@ ___ *Inherited from [Method](_method_.method.md).[filterOrigin](_method_.method.md#filterorigin)* -*Defined in [Method.ts:140](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L140)* +*Defined in [Method.ts:140](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L140)* **Parameters:** @@ -327,7 +327,7 @@ ___ *Inherited from [Method](_method_.method.md).[findFunction](_method_.method.md#findfunction)* -*Defined in [Method.ts:156](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L156)* +*Defined in [Method.ts:156](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L156)* **Parameters:** @@ -346,7 +346,7 @@ ___ *Inherited from [Method](_method_.method.md).[injectMethods](_method_.method.md#injectmethods)* -*Defined in [Method.ts:181](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L181)* +*Defined in [Method.ts:181](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L181)* **Parameters:** @@ -365,7 +365,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_proposalindex_.proposalindex.html b/docs/types/classes/_proposalindex_.proposalindex.html index 01c123a597..e045f82a64 100644 --- a/docs/types/classes/_proposalindex_.proposalindex.html +++ b/docs/types/classes/_proposalindex_.proposalindex.html @@ -2001,7 +2001,7 @@

⊕ new ProposalIndex(value?: AnyNumber): ProposalIndex

Inherited from U32.constructor

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -2026,7 +2026,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2035,7 +2035,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2101,7 +2101,7 @@ diff --git a/docs/types/classes/_proposalindex_.proposalindex.md b/docs/types/classes/_proposalindex_.proposalindex.md index c6cf7eddad..f332a664eb 100644 --- a/docs/types/classes/_proposalindex_.proposalindex.md +++ b/docs/types/classes/_proposalindex_.proposalindex.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/U32.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -69,7 +69,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_referendumindex_.referendumindex.html b/docs/types/classes/_referendumindex_.referendumindex.html index 665c8d1bfc..c62b798444 100644 --- a/docs/types/classes/_referendumindex_.referendumindex.html +++ b/docs/types/classes/_referendumindex_.referendumindex.html @@ -2001,7 +2001,7 @@

⊕ new ReferendumIndex(value?: AnyNumber): ReferendumIndex

Inherited from U32.constructor

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -2026,7 +2026,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2035,7 +2035,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2101,7 +2101,7 @@ diff --git a/docs/types/classes/_referendumindex_.referendumindex.md b/docs/types/classes/_referendumindex_.referendumindex.md index 761dd19c98..e8ba881faf 100644 --- a/docs/types/classes/_referendumindex_.referendumindex.md +++ b/docs/types/classes/_referendumindex_.referendumindex.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/U32.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -69,7 +69,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_referenduminfo_.referenduminfo.md b/docs/types/classes/_referenduminfo_.referenduminfo.md index 3116df813d..8dacdb4f65 100644 --- a/docs/types/classes/_referenduminfo_.referenduminfo.md +++ b/docs/types/classes/_referenduminfo_.referenduminfo.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [ReferendumInfo.ts:22](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ReferendumInfo.ts#L22)* +*Defined in [ReferendumInfo.ts:22](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ReferendumInfo.ts#L22)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -64,7 +64,7 @@ ___ getdelay(): [BlockNumber](_blocknumber_.blocknumber.md) -*Defined in [ReferendumInfo.ts:56](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ReferendumInfo.ts#L56)* +*Defined in [ReferendumInfo.ts:56](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ReferendumInfo.ts#L56)* *__description__*: The delay (in blocks) to wait after a successful referendum before deploying @@ -79,7 +79,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -92,7 +92,7 @@ ___ getend(): [BlockNumber](_blocknumber_.blocknumber.md) -*Defined in [ReferendumInfo.ts:35](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ReferendumInfo.ts#L35)* +*Defined in [ReferendumInfo.ts:35](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ReferendumInfo.ts#L35)* *__description__*: When voting on this referendum will end @@ -105,7 +105,7 @@ ___ getproposal(): [Proposal](_proposal_.proposal.md) -*Defined in [ReferendumInfo.ts:42](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ReferendumInfo.ts#L42)* +*Defined in [ReferendumInfo.ts:42](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ReferendumInfo.ts#L42)* *__description__*: The proposal being voted on @@ -118,7 +118,7 @@ ___ getthreshold(): [VoteThreshold](_votethreshold_.votethreshold.md) -*Defined in [ReferendumInfo.ts:49](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ReferendumInfo.ts#L49)* +*Defined in [ReferendumInfo.ts:49](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ReferendumInfo.ts#L49)* *__description__*: The thresholding mechanism to determine whether it passed @@ -138,7 +138,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -159,7 +159,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -180,7 +180,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -197,7 +197,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -214,7 +214,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -231,7 +231,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -246,7 +246,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -267,7 +267,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_runtimeversion_.apiid.html b/docs/types/classes/_runtimeversion_.apiid.html index f7f22decce..d6f35b16b9 100644 --- a/docs/types/classes/_runtimeversion_.apiid.html +++ b/docs/types/classes/_runtimeversion_.apiid.html @@ -2002,7 +2002,7 @@

constructor

⊕ new ApiId(value?: AnyU8a): ApiId

Overrides U8aFixed.constructor

-

Defined in RuntimeVersion.ts:19

+

Defined in RuntimeVersion.ts:19

Parameters:

@@ -2025,7 +2025,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2034,7 +2034,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2043,7 +2043,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2052,7 +2052,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2084,7 +2084,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2093,7 +2093,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2103,7 +2103,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2111,7 +2111,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2177,7 +2177,7 @@ diff --git a/docs/types/classes/_runtimeversion_.apiid.md b/docs/types/classes/_runtimeversion_.apiid.md index acebbe1748..22c0c03e48 100644 --- a/docs/types/classes/_runtimeversion_.apiid.md +++ b/docs/types/classes/_runtimeversion_.apiid.md @@ -27,7 +27,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [RuntimeVersion.ts:19](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/RuntimeVersion.ts#L19)* +*Defined in [RuntimeVersion.ts:19](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/RuntimeVersion.ts#L19)* **Parameters:** @@ -49,7 +49,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -84,7 +84,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -101,7 +101,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -125,7 +125,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -142,7 +142,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -161,7 +161,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -176,7 +176,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_runtimeversion_.runtimeversion.html b/docs/types/classes/_runtimeversion_.runtimeversion.html index 1851135605..f41f36ab11 100644 --- a/docs/types/classes/_runtimeversion_.runtimeversion.html +++ b/docs/types/classes/_runtimeversion_.runtimeversion.html @@ -2005,7 +2005,7 @@

constructor

⊕ new RuntimeVersion(value?: RuntimeVersionValue | Uint8Array): RuntimeVersion

Overrides Struct.constructor

-

Defined in RuntimeVersion.ts:72

+

Defined in RuntimeVersion.ts:72

Parameters:

@@ -2029,21 +2029,21 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


apis

getapis(): Vector<RuntimeVersionApi>

-

Defined in RuntimeVersion.ts:93

+

Defined in RuntimeVersion.ts:93

description: The available APIs as RuntimeVersionApi

Returns: Vector<RuntimeVersionApi>


authoringVersion

getauthoringVersion(): U32

-

Defined in RuntimeVersion.ts:100

+

Defined in RuntimeVersion.ts:100

description: The authoring version as U32

Returns: U32


@@ -2051,35 +2051,35 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


implName

getimplName(): Text

-

Defined in RuntimeVersion.ts:107

+

Defined in RuntimeVersion.ts:107

description: The implementation name

Returns: Text


implVersion

getimplVersion(): U32

-

Defined in RuntimeVersion.ts:114

+

Defined in RuntimeVersion.ts:114

description: The implementation version

Returns: U32


specName

getspecName(): Text

-

Defined in RuntimeVersion.ts:121

+

Defined in RuntimeVersion.ts:121

description: The specification name

Returns: Text


specVersion

getspecVersion(): U32

-

Defined in RuntimeVersion.ts:128

+

Defined in RuntimeVersion.ts:128

description: The specification version

Returns: U32


@@ -2089,7 +2089,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2114,7 +2114,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2137,7 +2137,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2146,7 +2146,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2155,7 +2155,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2164,7 +2164,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2172,7 +2172,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2199,7 +2199,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2262,7 +2262,7 @@ diff --git a/docs/types/classes/_runtimeversion_.runtimeversion.md b/docs/types/classes/_runtimeversion_.runtimeversion.md index f382b96fd5..f5aa2669bb 100644 --- a/docs/types/classes/_runtimeversion_.runtimeversion.md +++ b/docs/types/classes/_runtimeversion_.runtimeversion.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [RuntimeVersion.ts:72](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/RuntimeVersion.ts#L72)* +*Defined in [RuntimeVersion.ts:72](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/RuntimeVersion.ts#L72)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -64,7 +64,7 @@ ___ getapis(): [Vector](_codec_vector_.vector.md)<[RuntimeVersionApi](_runtimeversion_.runtimeversionapi.md)> -*Defined in [RuntimeVersion.ts:93](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/RuntimeVersion.ts#L93)* +*Defined in [RuntimeVersion.ts:93](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/RuntimeVersion.ts#L93)* *__description__*: The available APIs as [RuntimeVersionApi](_runtimeversion_.runtimeversionapi.md) @@ -77,7 +77,7 @@ ___ getauthoringVersion(): [U32](_u32_.u32.md) -*Defined in [RuntimeVersion.ts:100](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/RuntimeVersion.ts#L100)* +*Defined in [RuntimeVersion.ts:100](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/RuntimeVersion.ts#L100)* *__description__*: The authoring version as [U32](_u32_.u32.md) @@ -92,7 +92,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -105,7 +105,7 @@ ___ getimplName(): [Text](_text_.text.md) -*Defined in [RuntimeVersion.ts:107](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/RuntimeVersion.ts#L107)* +*Defined in [RuntimeVersion.ts:107](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/RuntimeVersion.ts#L107)* *__description__*: The implementation name @@ -118,7 +118,7 @@ ___ getimplVersion(): [U32](_u32_.u32.md) -*Defined in [RuntimeVersion.ts:114](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/RuntimeVersion.ts#L114)* +*Defined in [RuntimeVersion.ts:114](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/RuntimeVersion.ts#L114)* *__description__*: The implementation version @@ -131,7 +131,7 @@ ___ getspecName(): [Text](_text_.text.md) -*Defined in [RuntimeVersion.ts:121](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/RuntimeVersion.ts#L121)* +*Defined in [RuntimeVersion.ts:121](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/RuntimeVersion.ts#L121)* *__description__*: The specification name @@ -144,7 +144,7 @@ ___ getspecVersion(): [U32](_u32_.u32.md) -*Defined in [RuntimeVersion.ts:128](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/RuntimeVersion.ts#L128)* +*Defined in [RuntimeVersion.ts:128](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/RuntimeVersion.ts#L128)* *__description__*: The specification version @@ -164,7 +164,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -185,7 +185,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -206,7 +206,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -223,7 +223,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -240,7 +240,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -257,7 +257,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -272,7 +272,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -293,7 +293,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_runtimeversion_.runtimeversionapi.html b/docs/types/classes/_runtimeversion_.runtimeversionapi.html index fa73f6de37..95850022f8 100644 --- a/docs/types/classes/_runtimeversion_.runtimeversionapi.html +++ b/docs/types/classes/_runtimeversion_.runtimeversionapi.html @@ -2002,7 +2002,7 @@

constructor

⊕ new RuntimeVersionApi(value?: RuntimeVersionApiValue | Uint8Array): RuntimeVersionApi

Overrides Tuple.constructor

-

Defined in RuntimeVersion.ts:35

+

Defined in RuntimeVersion.ts:35

Parameters:

@@ -2026,7 +2026,7 @@

Types

getTypes(): Array<string>

Inherited from Tuple.Types

-

Defined in codec/Tuple.ts:68

+

Defined in codec/Tuple.ts:68

description: The types definition of the tuple

Returns: Array<string>


@@ -2034,21 +2034,21 @@

encodedLength

getencodedLength(): number

Inherited from Tuple.encodedLength

-

Defined in codec/Tuple.ts:59

+

Defined in codec/Tuple.ts:59

description: The length of the value when encoded as a Uint8Array

Returns: number


id

getid(): ApiId

-

Defined in RuntimeVersion.ts:46

+

Defined in RuntimeVersion.ts:46

description: The ApiId

Returns: ApiId


version

getversion(): U32

-

Defined in RuntimeVersion.ts:53

+

Defined in RuntimeVersion.ts:53

description: The specific version as U32

Returns: U32


@@ -2058,7 +2058,7 @@

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Inherited from Tuple.filter

Overrides Array.filter

-

Defined in codec/Tuple.ts:126

+

Defined in codec/Tuple.ts:126

description: Filters the array with the callback

Parameters:

@@ -2089,7 +2089,7 @@

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Tuple.map

Overrides Array.map

-

Defined in codec/Tuple.ts:135

+

Defined in codec/Tuple.ts:135

description: Maps the array with the callback

Type parameters:

U

@@ -2121,7 +2121,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

-

Defined in codec/Tuple.ts:77

+

Defined in codec/Tuple.ts:77

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2130,7 +2130,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

-

Defined in codec/Tuple.ts:84

+

Defined in codec/Tuple.ts:84

description: Returns a hex string representation of the value

Returns: string


@@ -2139,7 +2139,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

-

Defined in codec/Tuple.ts:91

+

Defined in codec/Tuple.ts:91

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2149,7 +2149,7 @@

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:100

+

Defined in codec/Tuple.ts:100

description: Returns the string representation of the value

Returns: string


@@ -2157,7 +2157,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Tuple.toU8a

-

Defined in codec/Tuple.ts:109

+

Defined in codec/Tuple.ts:109

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2184,7 +2184,7 @@

<Static> with

▸ with(Types: TupleConstructors): Constructor<Tuple>

Inherited from Tuple.with

-

Defined in codec/Tuple.ts:48

+

Defined in codec/Tuple.ts:48

Parameters:

@@ -2245,7 +2245,7 @@ diff --git a/docs/types/classes/_runtimeversion_.runtimeversionapi.md b/docs/types/classes/_runtimeversion_.runtimeversionapi.md index 621da047bd..f6dd2990b0 100644 --- a/docs/types/classes/_runtimeversion_.runtimeversionapi.md +++ b/docs/types/classes/_runtimeversion_.runtimeversionapi.md @@ -27,7 +27,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [RuntimeVersion.ts:35](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/RuntimeVersion.ts#L35)* +*Defined in [RuntimeVersion.ts:35](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/RuntimeVersion.ts#L35)* **Parameters:** @@ -49,7 +49,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -64,7 +64,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -77,7 +77,7 @@ ___ getid(): [ApiId](_runtimeversion_.apiid.md) -*Defined in [RuntimeVersion.ts:46](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/RuntimeVersion.ts#L46)* +*Defined in [RuntimeVersion.ts:46](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/RuntimeVersion.ts#L46)* *__description__*: The [ApiId](_runtimeversion_.apiid.md) @@ -90,7 +90,7 @@ ___ getversion(): [U32](_u32_.u32.md) -*Defined in [RuntimeVersion.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/RuntimeVersion.ts#L53)* +*Defined in [RuntimeVersion.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/RuntimeVersion.ts#L53)* *__description__*: The specific version as [U32](_u32_.u32.md) @@ -110,7 +110,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L126)* +*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L126)* *__description__*: Filters the array with the callback @@ -134,7 +134,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L135)* +*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L135)* *__description__*: Maps the array with the callback @@ -159,7 +159,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Converts the Object to an standard JavaScript Array @@ -176,7 +176,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Returns a hex string representation of the value @@ -193,7 +193,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -212,7 +212,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L100)* +*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L100)* *__description__*: Returns the string representation of the value @@ -227,7 +227,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L109)* +*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L109)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -248,7 +248,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_sessionkey_.sessionkey.html b/docs/types/classes/_sessionkey_.sessionkey.html index c584a515a3..292bdc88e6 100644 --- a/docs/types/classes/_sessionkey_.sessionkey.html +++ b/docs/types/classes/_sessionkey_.sessionkey.html @@ -2003,7 +2003,7 @@

⊕ new SessionKey(value?: AnyU8a): SessionKey

Inherited from AccountId.constructor

Overrides U8aFixed.constructor

-

Defined in AccountId.ts:19

+

Defined in AccountId.ts:19

Parameters:

@@ -2028,7 +2028,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2037,7 +2037,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2046,7 +2046,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2055,7 +2055,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2087,7 +2087,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2097,7 +2097,7 @@

Implementation of Codec.toJSON

Inherited from AccountId.toJSON

Overrides U8a.toJSON

-

Defined in AccountId.ts:46

+

Defined in AccountId.ts:46

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2107,7 +2107,7 @@

Implementation of Codec.toString

Inherited from AccountId.toString

Overrides U8a.toString

-

Defined in AccountId.ts:53

+

Defined in AccountId.ts:53

description: Returns the string representation of the value

Returns: string


@@ -2115,7 +2115,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2142,7 +2142,7 @@

<Static> encode

▸ encode(value: Uint8Array): string

Inherited from AccountId.encode

-

Defined in AccountId.ts:27

+

Defined in AccountId.ts:27

Parameters:

@@ -2203,7 +2203,7 @@ diff --git a/docs/types/classes/_sessionkey_.sessionkey.md b/docs/types/classes/_sessionkey_.sessionkey.md index a572aec7b0..68bfbb591c 100644 --- a/docs/types/classes/_sessionkey_.sessionkey.md +++ b/docs/types/classes/_sessionkey_.sessionkey.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AccountId.ts#L19)* +*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AccountId.ts#L19)* **Parameters:** @@ -51,7 +51,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -68,7 +68,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -86,7 +86,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -103,7 +103,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -127,7 +127,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -146,7 +146,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AccountId.ts#L46)* +*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AccountId.ts#L46)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -165,7 +165,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AccountId.ts#L53)* +*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AccountId.ts#L53)* *__description__*: Returns the string representation of the value @@ -180,7 +180,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -201,7 +201,7 @@ ___ *Inherited from [AccountId](_accountid_.accountid.md).[encode](_accountid_.accountid.md#encode)* -*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AccountId.ts#L27)* +*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AccountId.ts#L27)* **Parameters:** diff --git a/docs/types/classes/_signature_.signature.html b/docs/types/classes/_signature_.signature.html index beb7477cca..0a3ffdb82a 100644 --- a/docs/types/classes/_signature_.signature.html +++ b/docs/types/classes/_signature_.signature.html @@ -2004,7 +2004,7 @@

⊕ new Signature(value?: AnyU8a): Signature

Inherited from H512.constructor

Overrides U8aFixed.constructor

-

Defined in H512.ts:14

+

Defined in H512.ts:14

Parameters:

@@ -2027,7 +2027,7 @@

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2036,7 +2036,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2045,7 +2045,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2054,7 +2054,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2086,7 +2086,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2095,7 +2095,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2105,7 +2105,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2113,7 +2113,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2179,7 +2179,7 @@ diff --git a/docs/types/classes/_signature_.signature.md b/docs/types/classes/_signature_.signature.md index d1332bead5..68ac8e6e46 100644 --- a/docs/types/classes/_signature_.signature.md +++ b/docs/types/classes/_signature_.signature.md @@ -31,7 +31,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/H512.ts#L14)* +*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/H512.ts#L14)* **Parameters:** @@ -53,7 +53,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -70,7 +70,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -88,7 +88,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -105,7 +105,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -129,7 +129,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -146,7 +146,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -165,7 +165,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -180,7 +180,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_signaturepayload_.signaturepayload.html b/docs/types/classes/_signaturepayload_.signaturepayload.html index 526d1f9b33..b55f612601 100644 --- a/docs/types/classes/_signaturepayload_.signaturepayload.html +++ b/docs/types/classes/_signaturepayload_.signaturepayload.html @@ -2006,7 +2006,7 @@

constructor

⊕ new SignaturePayload(value?: SignaturePayloadValue | Uint8Array): SignaturePayload

Overrides Struct.constructor

-

Defined in SignaturePayload.ts:33

+

Defined in SignaturePayload.ts:33

Parameters:

@@ -2030,14 +2030,14 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


blockHash

getblockHash(): Hash

-

Defined in SignaturePayload.ts:54

+

Defined in SignaturePayload.ts:54

description: The block Hash the signature applies to (mortal/immortal)

Returns: Hash


@@ -2045,42 +2045,42 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


era

getera(): ExtrinsicEra

-

Defined in SignaturePayload.ts:68

+

Defined in SignaturePayload.ts:68

description: The ExtrinsicEra

Returns: ExtrinsicEra


isSigned

getisSigned(): boolean

-

Defined in SignaturePayload.ts:47

+

Defined in SignaturePayload.ts:47

description: true if the payload refers to a valid signature

Returns: boolean


method

getmethod(): Method

-

Defined in SignaturePayload.ts:61

+

Defined in SignaturePayload.ts:61

description: The Method contained in the payload

Returns: Method


nonce

getnonce(): Nonce

-

Defined in SignaturePayload.ts:75

+

Defined in SignaturePayload.ts:75

description: The Nonce

Returns: Nonce


signature

getsignature(): Uint8Array

-

Defined in SignaturePayload.ts:82

+

Defined in SignaturePayload.ts:82

description: The raw signature as a Uint8Array

Returns: Uint8Array


@@ -2090,7 +2090,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2115,7 +2115,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2137,7 +2137,7 @@

sign

▸ sign(signerPair: KeyringPair): Uint8Array

-

Defined in SignaturePayload.ts:93

+

Defined in SignaturePayload.ts:93

description: Sign the payload with the keypair

Parameters:

@@ -2160,7 +2160,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2169,7 +2169,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2178,7 +2178,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2187,7 +2187,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2195,7 +2195,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2222,7 +2222,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2285,7 +2285,7 @@ diff --git a/docs/types/classes/_signaturepayload_.signaturepayload.md b/docs/types/classes/_signaturepayload_.signaturepayload.md index 6003388be0..9e8112a9d2 100644 --- a/docs/types/classes/_signaturepayload_.signaturepayload.md +++ b/docs/types/classes/_signaturepayload_.signaturepayload.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [SignaturePayload.ts:33](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/SignaturePayload.ts#L33)* +*Defined in [SignaturePayload.ts:33](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/SignaturePayload.ts#L33)* **Parameters:** @@ -53,7 +53,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -66,7 +66,7 @@ ___ getblockHash(): [Hash](_hash_.hash.md) -*Defined in [SignaturePayload.ts:54](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/SignaturePayload.ts#L54)* +*Defined in [SignaturePayload.ts:54](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/SignaturePayload.ts#L54)* *__description__*: The block [Hash](_hash_.hash.md) the signature applies to (mortal/immortal) @@ -81,7 +81,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -94,7 +94,7 @@ ___ getera(): [ExtrinsicEra](_extrinsicera_.extrinsicera.md) -*Defined in [SignaturePayload.ts:68](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/SignaturePayload.ts#L68)* +*Defined in [SignaturePayload.ts:68](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/SignaturePayload.ts#L68)* *__description__*: The [ExtrinsicEra](_extrinsicera_.extrinsicera.md) @@ -107,7 +107,7 @@ ___ getisSigned(): `boolean` -*Defined in [SignaturePayload.ts:47](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/SignaturePayload.ts#L47)* +*Defined in [SignaturePayload.ts:47](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/SignaturePayload.ts#L47)* *__description__*: `true` if the payload refers to a valid signature @@ -120,7 +120,7 @@ ___ getmethod(): [Method](_method_.method.md) -*Defined in [SignaturePayload.ts:61](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/SignaturePayload.ts#L61)* +*Defined in [SignaturePayload.ts:61](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/SignaturePayload.ts#L61)* *__description__*: The [Method](_method_.method.md) contained in the payload @@ -133,7 +133,7 @@ ___ getnonce(): [Nonce](_nonce_.nonce.md) -*Defined in [SignaturePayload.ts:75](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/SignaturePayload.ts#L75)* +*Defined in [SignaturePayload.ts:75](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/SignaturePayload.ts#L75)* *__description__*: The [Nonce](_nonce_.nonce.md) @@ -146,7 +146,7 @@ ___ getsignature(): `Uint8Array` -*Defined in [SignaturePayload.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/SignaturePayload.ts#L82)* +*Defined in [SignaturePayload.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/SignaturePayload.ts#L82)* *__description__*: The raw signature as a `Uint8Array` @@ -166,7 +166,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -187,7 +187,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -206,7 +206,7 @@ ___ ▸ **sign**(signerPair: *`KeyringPair`*): `Uint8Array` -*Defined in [SignaturePayload.ts:93](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/SignaturePayload.ts#L93)* +*Defined in [SignaturePayload.ts:93](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/SignaturePayload.ts#L93)* *__description__*: Sign the payload with the keypair @@ -227,7 +227,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -244,7 +244,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -261,7 +261,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -278,7 +278,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -293,7 +293,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -314,7 +314,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_signedblock_.signedblock.html b/docs/types/classes/_signedblock_.signedblock.html index 853fc8fde0..79926ecbee 100644 --- a/docs/types/classes/_signedblock_.signedblock.html +++ b/docs/types/classes/_signedblock_.signedblock.html @@ -2005,7 +2005,7 @@

constructor

⊕ new SignedBlock(value?: SignedBlockValue | Uint8Array): SignedBlock

Overrides Struct.constructor

-

Defined in SignedBlock.ts:22

+

Defined in SignedBlock.ts:22

Parameters:

@@ -2029,14 +2029,14 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


block

getblock(): Block

-

Defined in SignedBlock.ts:33

+

Defined in SignedBlock.ts:33

description: The wrapped Block

Returns: Block


@@ -2044,21 +2044,21 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


hash

gethash(): Hash

-

Defined in SignedBlock.ts:40

+

Defined in SignedBlock.ts:40

description: Block/header Hash

Returns: Hash


justification

getjustification(): Justification

-

Defined in SignedBlock.ts:47

+

Defined in SignedBlock.ts:47

description: The wrapped Justification

Returns: Justification


@@ -2068,7 +2068,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2093,7 +2093,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2116,7 +2116,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2125,7 +2125,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2134,7 +2134,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2143,7 +2143,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2151,7 +2151,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2178,7 +2178,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2241,7 +2241,7 @@ diff --git a/docs/types/classes/_signedblock_.signedblock.md b/docs/types/classes/_signedblock_.signedblock.md index 7d4cac6fd7..222a760028 100644 --- a/docs/types/classes/_signedblock_.signedblock.md +++ b/docs/types/classes/_signedblock_.signedblock.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [SignedBlock.ts:22](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/SignedBlock.ts#L22)* +*Defined in [SignedBlock.ts:22](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/SignedBlock.ts#L22)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -64,7 +64,7 @@ ___ getblock(): [Block](_block_.block.md) -*Defined in [SignedBlock.ts:33](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/SignedBlock.ts#L33)* +*Defined in [SignedBlock.ts:33](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/SignedBlock.ts#L33)* *__description__*: The wrapped [Block](_block_.block.md) @@ -79,7 +79,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -92,7 +92,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [SignedBlock.ts:40](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/SignedBlock.ts#L40)* +*Defined in [SignedBlock.ts:40](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/SignedBlock.ts#L40)* *__description__*: Block/header [Hash](_hash_.hash.md) @@ -105,7 +105,7 @@ ___ getjustification(): [Justification](_justification_.justification.md) -*Defined in [SignedBlock.ts:47](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/SignedBlock.ts#L47)* +*Defined in [SignedBlock.ts:47](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/SignedBlock.ts#L47)* *__description__*: The wrapped [Justification](_justification_.justification.md) @@ -125,7 +125,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -146,7 +146,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -167,7 +167,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -184,7 +184,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -201,7 +201,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -218,7 +218,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -233,7 +233,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -254,7 +254,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_storagechangeset_.storagechangeset.html b/docs/types/classes/_storagechangeset_.storagechangeset.html index e7ad241725..10aff3598b 100644 --- a/docs/types/classes/_storagechangeset_.storagechangeset.html +++ b/docs/types/classes/_storagechangeset_.storagechangeset.html @@ -2005,7 +2005,7 @@

constructor

⊕ new StorageChangeSet(value?: StorageChangeSetValue | Uint8Array): StorageChangeSet

Overrides Struct.constructor

-

Defined in StorageChangeSet.ts:24

+

Defined in StorageChangeSet.ts:24

Parameters:

@@ -2029,21 +2029,21 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


block

getblock(): Hash

-

Defined in StorageChangeSet.ts:42

+

Defined in StorageChangeSet.ts:42

description: The block Hash

Returns: Hash


changes

getchanges(): Vector<KeyValueOption>

-

Defined in StorageChangeSet.ts:35

+

Defined in StorageChangeSet.ts:35

description: The applicable changes as KeyValueOption

Returns: Vector<KeyValueOption>


@@ -2051,7 +2051,7 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2061,7 +2061,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2086,7 +2086,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2109,7 +2109,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2118,7 +2118,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2127,7 +2127,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2136,7 +2136,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2144,7 +2144,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2171,7 +2171,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2234,7 +2234,7 @@ diff --git a/docs/types/classes/_storagechangeset_.storagechangeset.md b/docs/types/classes/_storagechangeset_.storagechangeset.md index 86c149cfcd..7ec693cf9e 100644 --- a/docs/types/classes/_storagechangeset_.storagechangeset.md +++ b/docs/types/classes/_storagechangeset_.storagechangeset.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [StorageChangeSet.ts:24](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageChangeSet.ts#L24)* +*Defined in [StorageChangeSet.ts:24](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageChangeSet.ts#L24)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -64,7 +64,7 @@ ___ getblock(): [Hash](_hash_.hash.md) -*Defined in [StorageChangeSet.ts:42](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageChangeSet.ts#L42)* +*Defined in [StorageChangeSet.ts:42](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageChangeSet.ts#L42)* *__description__*: The block [Hash](_hash_.hash.md) @@ -77,7 +77,7 @@ ___ getchanges(): [Vector](_codec_vector_.vector.md)<[KeyValueOption](_keyvalue_.keyvalueoption.md)> -*Defined in [StorageChangeSet.ts:35](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageChangeSet.ts#L35)* +*Defined in [StorageChangeSet.ts:35](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageChangeSet.ts#L35)* *__description__*: The applicable changes as [KeyValueOption](_keyvalue_.keyvalueoption.md) @@ -92,7 +92,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -112,7 +112,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -133,7 +133,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -154,7 +154,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -171,7 +171,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -188,7 +188,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -205,7 +205,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -220,7 +220,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -241,7 +241,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_storagedata_.storagedata.html b/docs/types/classes/_storagedata_.storagedata.html index 93c46309ec..8103c2430e 100644 --- a/docs/types/classes/_storagedata_.storagedata.html +++ b/docs/types/classes/_storagedata_.storagedata.html @@ -2003,7 +2003,7 @@

⊕ new StorageData(value?: AnyU8a): StorageData

Inherited from Bytes.constructor

Overrides U8a.constructor

-

Defined in Bytes.ts:18

+

Defined in Bytes.ts:18

Parameters:

@@ -2027,7 +2027,7 @@

getencodedLength(): number

Inherited from Bytes.encodedLength

Overrides U8a.encodedLength

-

Defined in Bytes.ts:64

+

Defined in Bytes.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2036,7 +2036,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2046,7 +2046,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2078,7 +2078,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2087,7 +2087,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2097,7 +2097,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2106,7 +2106,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Bytes.toU8a

Overrides U8a.toU8a

-

Defined in Bytes.ts:72

+

Defined in Bytes.ts:72

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2172,7 +2172,7 @@ diff --git a/docs/types/classes/_storagedata_.storagedata.md b/docs/types/classes/_storagedata_.storagedata.md index f5a2263023..fb977f2a0a 100644 --- a/docs/types/classes/_storagedata_.storagedata.md +++ b/docs/types/classes/_storagedata_.storagedata.md @@ -29,7 +29,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bytes.ts#L18)* +*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bytes.ts#L18)* **Parameters:** @@ -53,7 +53,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bytes.ts#L64)* +*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bytes.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -70,7 +70,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -90,7 +90,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -114,7 +114,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -131,7 +131,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -150,7 +150,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -167,7 +167,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bytes.ts#L72)* +*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bytes.ts#L72)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_storagekey_.storagekey.html b/docs/types/classes/_storagekey_.storagekey.html index d8c7eb5f89..1e745f7a17 100644 --- a/docs/types/classes/_storagekey_.storagekey.html +++ b/docs/types/classes/_storagekey_.storagekey.html @@ -2002,7 +2002,7 @@

constructor

⊕ new StorageKey(value: AnyU8a | StorageKey | StorageFunction | [StorageFunction, any]): StorageKey

Overrides Bytes.constructor

-

Defined in StorageKey.ts:28

+

Defined in StorageKey.ts:28

Parameters:

@@ -2029,7 +2029,7 @@

getencodedLength(): number

Inherited from Bytes.encodedLength

Overrides U8a.encodedLength

-

Defined in Bytes.ts:64

+

Defined in Bytes.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2038,21 +2038,21 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


meta

getmeta(): StorageFunctionMetadata | null

-

Defined in StorageKey.ts:82

+

Defined in StorageKey.ts:82

description: The metadata or null when not available

Returns: StorageFunctionMetadata | null


outputType

getoutputType(): string | null

-

Defined in StorageKey.ts:89

+

Defined in StorageKey.ts:89

description: The output type, null when not available

Returns: string | null


@@ -2062,7 +2062,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2094,7 +2094,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2103,7 +2103,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2113,7 +2113,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2122,7 +2122,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Bytes.toU8a

Overrides U8a.toU8a

-

Defined in Bytes.ts:72

+

Defined in Bytes.ts:72

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2148,7 +2148,7 @@

<Static> decodeStorageKey

▸ decodeStorageKey(value: AnyU8a | StorageKey | StorageFunction | [StorageFunction, any]): Uint8Array

-

Defined in StorageKey.ts:37

+

Defined in StorageKey.ts:37

Parameters:

@@ -2172,7 +2172,7 @@

<Static> getMeta

▸ getMeta(value: StorageKey | StorageFunction | [StorageFunction, any]): StorageFunctionMetadata | null

-

Defined in StorageKey.ts:51

+

Defined in StorageKey.ts:51

Parameters:

@@ -2195,7 +2195,7 @@

<Static> getType

▸ getType(value: StorageKey | StorageFunction | [StorageFunction, any]): string | null

-

Defined in StorageKey.ts:65

+

Defined in StorageKey.ts:65

Parameters:

@@ -2258,7 +2258,7 @@ diff --git a/docs/types/classes/_storagekey_.storagekey.md b/docs/types/classes/_storagekey_.storagekey.md index 21b3972769..79a68117ff 100644 --- a/docs/types/classes/_storagekey_.storagekey.md +++ b/docs/types/classes/_storagekey_.storagekey.md @@ -27,7 +27,7 @@ *Overrides [Bytes](_bytes_.bytes.md).[constructor](_bytes_.bytes.md#constructor)* -*Defined in [StorageKey.ts:28](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageKey.ts#L28)* +*Defined in [StorageKey.ts:28](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageKey.ts#L28)* **Parameters:** @@ -51,7 +51,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bytes.ts#L64)* +*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bytes.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -68,7 +68,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -81,7 +81,7 @@ ___ getmeta(): [StorageFunctionMetadata](_metadata_modules_.storagefunctionmetadata.md) | `null` -*Defined in [StorageKey.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageKey.ts#L82)* +*Defined in [StorageKey.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageKey.ts#L82)* *__description__*: The metadata or `null` when not available @@ -94,7 +94,7 @@ ___ getoutputType(): `string` | `null` -*Defined in [StorageKey.ts:89](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageKey.ts#L89)* +*Defined in [StorageKey.ts:89](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageKey.ts#L89)* *__description__*: The output type, `null` when not available @@ -114,7 +114,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -138,7 +138,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -155,7 +155,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -174,7 +174,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -191,7 +191,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bytes.ts#L72)* +*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bytes.ts#L72)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -210,7 +210,7 @@ ___ ▸ **decodeStorageKey**(value: *[AnyU8a](../modules/_types_.md#anyu8a) | [StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]*): `Uint8Array` -*Defined in [StorageKey.ts:37](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageKey.ts#L37)* +*Defined in [StorageKey.ts:37](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageKey.ts#L37)* **Parameters:** @@ -227,7 +227,7 @@ ___ ▸ **getMeta**(value: *[StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]*): [StorageFunctionMetadata](_metadata_modules_.storagefunctionmetadata.md) | `null` -*Defined in [StorageKey.ts:51](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageKey.ts#L51)* +*Defined in [StorageKey.ts:51](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageKey.ts#L51)* **Parameters:** @@ -244,7 +244,7 @@ ___ ▸ **getType**(value: *[StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]*): `string` | `null` -*Defined in [StorageKey.ts:65](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageKey.ts#L65)* +*Defined in [StorageKey.ts:65](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageKey.ts#L65)* **Parameters:** diff --git a/docs/types/classes/_storedpendingchange_.nextauthority.html b/docs/types/classes/_storedpendingchange_.nextauthority.html index 3c00b885eb..163b959b43 100644 --- a/docs/types/classes/_storedpendingchange_.nextauthority.html +++ b/docs/types/classes/_storedpendingchange_.nextauthority.html @@ -2002,7 +2002,7 @@

constructor

⊕ new NextAuthority(value?: Uint8Array | NextAuthorityValue): NextAuthority

Overrides Tuple.constructor

-

Defined in StoredPendingChange.ts:31

+

Defined in StoredPendingChange.ts:31

Parameters:

@@ -2026,7 +2026,7 @@

Types

getTypes(): Array<string>

Inherited from Tuple.Types

-

Defined in codec/Tuple.ts:68

+

Defined in codec/Tuple.ts:68

description: The types definition of the tuple

Returns: Array<string>


@@ -2034,20 +2034,20 @@

encodedLength

getencodedLength(): number

Inherited from Tuple.encodedLength

-

Defined in codec/Tuple.ts:59

+

Defined in codec/Tuple.ts:59

description: The length of the value when encoded as a Uint8Array

Returns: number


index

getindex(): U64

-

Defined in StoredPendingChange.ts:39

+

Defined in StoredPendingChange.ts:39

Returns: U64


sessionKey

getsessionKey(): SessionKey

-

Defined in StoredPendingChange.ts:43

+

Defined in StoredPendingChange.ts:43

Returns: SessionKey


Methods

@@ -2056,7 +2056,7 @@

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Inherited from Tuple.filter

Overrides Array.filter

-

Defined in codec/Tuple.ts:126

+

Defined in codec/Tuple.ts:126

description: Filters the array with the callback

Parameters:

@@ -2087,7 +2087,7 @@

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Tuple.map

Overrides Array.map

-

Defined in codec/Tuple.ts:135

+

Defined in codec/Tuple.ts:135

description: Maps the array with the callback

Type parameters:

U

@@ -2119,7 +2119,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

-

Defined in codec/Tuple.ts:77

+

Defined in codec/Tuple.ts:77

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2128,7 +2128,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

-

Defined in codec/Tuple.ts:84

+

Defined in codec/Tuple.ts:84

description: Returns a hex string representation of the value

Returns: string


@@ -2137,7 +2137,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

-

Defined in codec/Tuple.ts:91

+

Defined in codec/Tuple.ts:91

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2147,7 +2147,7 @@

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:100

+

Defined in codec/Tuple.ts:100

description: Returns the string representation of the value

Returns: string


@@ -2155,7 +2155,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Tuple.toU8a

-

Defined in codec/Tuple.ts:109

+

Defined in codec/Tuple.ts:109

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2182,7 +2182,7 @@

<Static> with

▸ with(Types: TupleConstructors): Constructor<Tuple>

Inherited from Tuple.with

-

Defined in codec/Tuple.ts:48

+

Defined in codec/Tuple.ts:48

Parameters:

@@ -2243,7 +2243,7 @@ diff --git a/docs/types/classes/_storedpendingchange_.nextauthority.md b/docs/types/classes/_storedpendingchange_.nextauthority.md index 96ce83ae4a..d56b77b11a 100644 --- a/docs/types/classes/_storedpendingchange_.nextauthority.md +++ b/docs/types/classes/_storedpendingchange_.nextauthority.md @@ -27,7 +27,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [StoredPendingChange.ts:31](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StoredPendingChange.ts#L31)* +*Defined in [StoredPendingChange.ts:31](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StoredPendingChange.ts#L31)* **Parameters:** @@ -49,7 +49,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L68)* *__description__*: The types definition of the tuple @@ -64,7 +64,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -77,7 +77,7 @@ ___ getindex(): [U64](_u64_.u64.md) -*Defined in [StoredPendingChange.ts:39](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StoredPendingChange.ts#L39)* +*Defined in [StoredPendingChange.ts:39](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StoredPendingChange.ts#L39)* **Returns:** [U64](_u64_.u64.md) @@ -88,7 +88,7 @@ ___ getsessionKey(): [SessionKey](_sessionkey_.sessionkey.md) -*Defined in [StoredPendingChange.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StoredPendingChange.ts#L43)* +*Defined in [StoredPendingChange.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StoredPendingChange.ts#L43)* **Returns:** [SessionKey](_sessionkey_.sessionkey.md) @@ -106,7 +106,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L126)* +*Defined in [codec/Tuple.ts:126](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L126)* *__description__*: Filters the array with the callback @@ -130,7 +130,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L135)* +*Defined in [codec/Tuple.ts:135](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L135)* *__description__*: Maps the array with the callback @@ -155,7 +155,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L77)* +*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L77)* *__description__*: Converts the Object to an standard JavaScript Array @@ -172,7 +172,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Returns a hex string representation of the value @@ -189,7 +189,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -208,7 +208,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L100)* +*Defined in [codec/Tuple.ts:100](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L100)* *__description__*: Returns the string representation of the value @@ -223,7 +223,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L109)* +*Defined in [codec/Tuple.ts:109](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L109)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -244,7 +244,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_storedpendingchange_.storedpendingchange.html b/docs/types/classes/_storedpendingchange_.storedpendingchange.html index fc1f72c558..b05c96f5dc 100644 --- a/docs/types/classes/_storedpendingchange_.storedpendingchange.html +++ b/docs/types/classes/_storedpendingchange_.storedpendingchange.html @@ -2005,7 +2005,7 @@

constructor

⊕ new StoredPendingChange(value?: Uint8Array | StoredPendingChangeValue): StoredPendingChange

Overrides Struct.constructor

-

Defined in StoredPendingChange.ts:53

+

Defined in StoredPendingChange.ts:53

Parameters:

@@ -2029,34 +2029,34 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


delay

getdelay(): BlockNumber

-

Defined in StoredPendingChange.ts:65

+

Defined in StoredPendingChange.ts:65

Returns: BlockNumber


encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


nextAuthorities

getnextAuthorities(): Vector<NextAuthority>

-

Defined in StoredPendingChange.ts:69

+

Defined in StoredPendingChange.ts:69

Returns: Vector<NextAuthority>


scheduledAt

getscheduledAt(): BlockNumber

-

Defined in StoredPendingChange.ts:73

+

Defined in StoredPendingChange.ts:73

Returns: BlockNumber


Methods

@@ -2065,7 +2065,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2090,7 +2090,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2113,7 +2113,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2122,7 +2122,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2131,7 +2131,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2140,7 +2140,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2148,7 +2148,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2175,7 +2175,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2238,7 +2238,7 @@ diff --git a/docs/types/classes/_storedpendingchange_.storedpendingchange.md b/docs/types/classes/_storedpendingchange_.storedpendingchange.md index e8ddbd4557..3f12399ca0 100644 --- a/docs/types/classes/_storedpendingchange_.storedpendingchange.md +++ b/docs/types/classes/_storedpendingchange_.storedpendingchange.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [StoredPendingChange.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StoredPendingChange.ts#L53)* +*Defined in [StoredPendingChange.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StoredPendingChange.ts#L53)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -64,7 +64,7 @@ ___ getdelay(): [BlockNumber](_blocknumber_.blocknumber.md) -*Defined in [StoredPendingChange.ts:65](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StoredPendingChange.ts#L65)* +*Defined in [StoredPendingChange.ts:65](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StoredPendingChange.ts#L65)* **Returns:** [BlockNumber](_blocknumber_.blocknumber.md) @@ -77,7 +77,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -90,7 +90,7 @@ ___ getnextAuthorities(): [Vector](_codec_vector_.vector.md)<[NextAuthority](_storedpendingchange_.nextauthority.md)> -*Defined in [StoredPendingChange.ts:69](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StoredPendingChange.ts#L69)* +*Defined in [StoredPendingChange.ts:69](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StoredPendingChange.ts#L69)* **Returns:** [Vector](_codec_vector_.vector.md)<[NextAuthority](_storedpendingchange_.nextauthority.md)> @@ -101,7 +101,7 @@ ___ getscheduledAt(): [BlockNumber](_blocknumber_.blocknumber.md) -*Defined in [StoredPendingChange.ts:73](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StoredPendingChange.ts#L73)* +*Defined in [StoredPendingChange.ts:73](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StoredPendingChange.ts#L73)* **Returns:** [BlockNumber](_blocknumber_.blocknumber.md) @@ -119,7 +119,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -140,7 +140,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -161,7 +161,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -178,7 +178,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -195,7 +195,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -212,7 +212,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -227,7 +227,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -248,7 +248,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_text_.text.html b/docs/types/classes/_text_.text.html index 7d138d064a..26415996a6 100644 --- a/docs/types/classes/_text_.text.html +++ b/docs/types/classes/_text_.text.html @@ -2002,7 +2002,7 @@

constructor

⊕ new Text(value?: Text | string | AnyU8a | object): Text

-

Defined in Text.ts:23

+

Defined in Text.ts:23

Parameters:

@@ -2036,7 +2036,7 @@

encodedLength

getencodedLength(): number

-

Defined in Text.ts:47

+

Defined in Text.ts:47

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2044,7 +2044,7 @@

length

getlength(): number

Overrides String.length

-

Defined in Text.ts:54

+

Defined in Text.ts:54

description: The length of the value

Returns: number


@@ -2053,7 +2053,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in Text.ts:62

+

Defined in Text.ts:62

description: Returns a hex string representation of the value

Returns: string


@@ -2061,7 +2061,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in Text.ts:69

+

Defined in Text.ts:69

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2070,14 +2070,14 @@

▸ toString(): string

Implementation of Codec.toString

Overrides String.toString

-

Defined in Text.ts:76

+

Defined in Text.ts:76

description: Returns the string representation of the value

Returns: string


toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

-

Defined in Text.ts:85

+

Defined in Text.ts:85

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2143,7 +2143,7 @@ diff --git a/docs/types/classes/_text_.text.md b/docs/types/classes/_text_.text.md index 4d20198bee..f7960973a5 100644 --- a/docs/types/classes/_text_.text.md +++ b/docs/types/classes/_text_.text.md @@ -27,7 +27,7 @@ ⊕ **new Text**(value?: *[Text](_text_.text.md) | `string` | [AnyU8a](../modules/_types_.md#anyu8a) | `object`*): [Text](_text_.text.md) -*Defined in [Text.ts:23](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Text.ts#L23)* +*Defined in [Text.ts:23](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Text.ts#L23)* **Parameters:** @@ -61,7 +61,7 @@ ___ getencodedLength(): `number` -*Defined in [Text.ts:47](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Text.ts#L47)* +*Defined in [Text.ts:47](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Text.ts#L47)* *__description__*: The length of the value when encoded as a Uint8Array @@ -76,7 +76,7 @@ getlength(): `number` *Overrides String.length* -*Defined in [Text.ts:54](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Text.ts#L54)* +*Defined in [Text.ts:54](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Text.ts#L54)* *__description__*: The length of the value @@ -94,7 +94,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [Text.ts:62](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Text.ts#L62)* +*Defined in [Text.ts:62](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Text.ts#L62)* *__description__*: Returns a hex string representation of the value @@ -109,7 +109,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [Text.ts:69](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Text.ts#L69)* +*Defined in [Text.ts:69](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Text.ts#L69)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -126,7 +126,7 @@ ___ *Overrides String.toString* -*Defined in [Text.ts:76](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Text.ts#L76)* +*Defined in [Text.ts:76](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Text.ts#L76)* *__description__*: Returns the string representation of the value @@ -139,7 +139,7 @@ ___ ▸ **toU8a**(isBare?: *`undefined` | `false` | `true`*): `Uint8Array` -*Defined in [Text.ts:85](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Text.ts#L85)* +*Defined in [Text.ts:85](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Text.ts#L85)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_.type.html b/docs/types/classes/_type_.type.html index 644acfa7b1..12fedf1b95 100644 --- a/docs/types/classes/_type_.type.html +++ b/docs/types/classes/_type_.type.html @@ -2002,7 +2002,7 @@

constructor

⊕ new Type(value?: Text | Uint8Array | string): Type

Overrides Text.constructor

-

Defined in Type.ts:19

+

Defined in Type.ts:19

Parameters:

@@ -2029,7 +2029,7 @@

encodedLength

getencodedLength(): number

Overrides Text.encodedLength

-

Defined in Type.ts:72

+

Defined in Type.ts:72

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2038,7 +2038,7 @@

getlength(): number

Inherited from Text.length

Overrides String.length

-

Defined in Text.ts:54

+

Defined in Text.ts:54

description: The length of the value

Returns: number


@@ -2048,7 +2048,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Text.toHex

-

Defined in Text.ts:62

+

Defined in Text.ts:62

description: Returns a hex string representation of the value

Returns: string


@@ -2057,7 +2057,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Text.toJSON

-

Defined in Text.ts:69

+

Defined in Text.ts:69

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2067,7 +2067,7 @@

Implementation of Codec.toString

Inherited from Text.toString

Overrides String.toString

-

Defined in Text.ts:76

+

Defined in Text.ts:76

description: Returns the string representation of the value

Returns: string


@@ -2075,7 +2075,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Overrides Text.toU8a

-

Defined in Type.ts:83

+

Defined in Type.ts:83

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2141,7 +2141,7 @@ diff --git a/docs/types/classes/_type_.type.md b/docs/types/classes/_type_.type.md index 32880549c9..90e09830e0 100644 --- a/docs/types/classes/_type_.type.md +++ b/docs/types/classes/_type_.type.md @@ -27,7 +27,7 @@ *Overrides [Text](_text_.text.md).[constructor](_text_.text.md#constructor)* -*Defined in [Type.ts:19](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Type.ts#L19)* +*Defined in [Type.ts:19](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Type.ts#L19)* **Parameters:** @@ -49,7 +49,7 @@ getencodedLength(): `number` *Overrides [Text](_text_.text.md).[encodedLength](_text_.text.md#encodedlength)* -*Defined in [Type.ts:72](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Type.ts#L72)* +*Defined in [Type.ts:72](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Type.ts#L72)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ getlength(): `number` *Overrides String.length* -*Defined in [Text.ts:54](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Text.ts#L54)* +*Defined in [Text.ts:54](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Text.ts#L54)* *__description__*: The length of the value @@ -86,7 +86,7 @@ ___ *Inherited from [Text](_text_.text.md).[toHex](_text_.text.md#tohex)* -*Defined in [Text.ts:62](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Text.ts#L62)* +*Defined in [Text.ts:62](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Text.ts#L62)* *__description__*: Returns a hex string representation of the value @@ -103,7 +103,7 @@ ___ *Inherited from [Text](_text_.text.md).[toJSON](_text_.text.md#tojson)* -*Defined in [Text.ts:69](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Text.ts#L69)* +*Defined in [Text.ts:69](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Text.ts#L69)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -122,7 +122,7 @@ ___ *Overrides String.toString* -*Defined in [Text.ts:76](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Text.ts#L76)* +*Defined in [Text.ts:76](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Text.ts#L76)* *__description__*: Returns the string representation of the value @@ -137,7 +137,7 @@ ___ *Overrides [Text](_text_.text.md).[toU8a](_text_.text.md#tou8a)* -*Defined in [Type.ts:83](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Type.ts#L83)* +*Defined in [Type.ts:83](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Type.ts#L83)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_u128_.u128.html b/docs/types/classes/_u128_.u128.html index 4f4cec697f..4f85a181d8 100644 --- a/docs/types/classes/_u128_.u128.html +++ b/docs/types/classes/_u128_.u128.html @@ -2001,7 +2001,7 @@

constructor

⊕ new U128(value?: AnyNumber): U128

Overrides UInt.constructor

-

Defined in U128.ts:14

+

Defined in U128.ts:14

Parameters:

@@ -2026,7 +2026,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2035,7 +2035,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2101,7 +2101,7 @@ diff --git a/docs/types/classes/_u128_.u128.md b/docs/types/classes/_u128_.u128.md index 033161f1f3..d202b49fdb 100644 --- a/docs/types/classes/_u128_.u128.md +++ b/docs/types/classes/_u128_.u128.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/U128.ts#L14)* +*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/U128.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -69,7 +69,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_u16_.u16.html b/docs/types/classes/_u16_.u16.html index 5f2bfc3001..5972a62901 100644 --- a/docs/types/classes/_u16_.u16.html +++ b/docs/types/classes/_u16_.u16.html @@ -2000,7 +2000,7 @@

constructor

⊕ new U16(value?: AnyNumber): U16

Overrides UInt.constructor

-

Defined in U16.ts:14

+

Defined in U16.ts:14

Parameters:

@@ -2025,7 +2025,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2034,7 +2034,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2100,7 +2100,7 @@ diff --git a/docs/types/classes/_u16_.u16.md b/docs/types/classes/_u16_.u16.md index 3518e3034a..f790b649e0 100644 --- a/docs/types/classes/_u16_.u16.md +++ b/docs/types/classes/_u16_.u16.md @@ -24,7 +24,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U16.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/U16.ts#L14)* +*Defined in [U16.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/U16.ts#L14)* **Parameters:** @@ -50,7 +50,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -67,7 +67,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_u256_.u256.html b/docs/types/classes/_u256_.u256.html index 1291bc286a..22b800a244 100644 --- a/docs/types/classes/_u256_.u256.html +++ b/docs/types/classes/_u256_.u256.html @@ -2000,7 +2000,7 @@

constructor

⊕ new U256(value?: AnyNumber): U256

Overrides UInt.constructor

-

Defined in U256.ts:14

+

Defined in U256.ts:14

Parameters:

@@ -2025,7 +2025,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2034,7 +2034,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2100,7 +2100,7 @@ diff --git a/docs/types/classes/_u256_.u256.md b/docs/types/classes/_u256_.u256.md index 7b7aa605b6..d0aab636ad 100644 --- a/docs/types/classes/_u256_.u256.md +++ b/docs/types/classes/_u256_.u256.md @@ -24,7 +24,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U256.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/U256.ts#L14)* +*Defined in [U256.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/U256.ts#L14)* **Parameters:** @@ -50,7 +50,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -67,7 +67,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_u32_.u32.html b/docs/types/classes/_u32_.u32.html index 8938d39eeb..92dee5efe8 100644 --- a/docs/types/classes/_u32_.u32.html +++ b/docs/types/classes/_u32_.u32.html @@ -2009,7 +2009,7 @@

constructor

⊕ new U32(value?: AnyNumber): U32

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -2034,7 +2034,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2043,7 +2043,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2109,7 +2109,7 @@ diff --git a/docs/types/classes/_u32_.u32.md b/docs/types/classes/_u32_.u32.md index 36ff788fad..970ca98f62 100644 --- a/docs/types/classes/_u32_.u32.md +++ b/docs/types/classes/_u32_.u32.md @@ -42,7 +42,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/U32.ts#L14)* **Parameters:** @@ -68,7 +68,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -85,7 +85,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_u64_.u64.html b/docs/types/classes/_u64_.u64.html index 21ccbe2075..5c00f2e266 100644 --- a/docs/types/classes/_u64_.u64.html +++ b/docs/types/classes/_u64_.u64.html @@ -2003,7 +2003,7 @@

constructor

⊕ new U64(value?: AnyNumber): U64

Overrides UInt.constructor

-

Defined in U64.ts:14

+

Defined in U64.ts:14

Parameters:

@@ -2028,7 +2028,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2037,7 +2037,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2103,7 +2103,7 @@ diff --git a/docs/types/classes/_u64_.u64.md b/docs/types/classes/_u64_.u64.md index ad3da885c7..ff05d5890b 100644 --- a/docs/types/classes/_u64_.u64.md +++ b/docs/types/classes/_u64_.u64.md @@ -30,7 +30,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/U64.ts#L14)* +*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/U64.ts#L14)* **Parameters:** @@ -56,7 +56,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -73,7 +73,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_u8_.u8.html b/docs/types/classes/_u8_.u8.html index a40a1ce33f..efe6d8490d 100644 --- a/docs/types/classes/_u8_.u8.html +++ b/docs/types/classes/_u8_.u8.html @@ -2000,7 +2000,7 @@

constructor

⊕ new U8(value?: AnyNumber): U8

Overrides UInt.constructor

-

Defined in U8.ts:14

+

Defined in U8.ts:14

Parameters:

@@ -2025,7 +2025,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2034,7 +2034,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2100,7 +2100,7 @@ diff --git a/docs/types/classes/_u8_.u8.md b/docs/types/classes/_u8_.u8.md index d9d2e1bcdd..e30c8021ad 100644 --- a/docs/types/classes/_u8_.u8.md +++ b/docs/types/classes/_u8_.u8.md @@ -24,7 +24,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U8.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/U8.ts#L14)* +*Defined in [U8.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/U8.ts#L14)* **Parameters:** @@ -50,7 +50,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -67,7 +67,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_validatorprefs_.validatorprefs.html b/docs/types/classes/_validatorprefs_.validatorprefs.html index 64ddbc7f1f..60e6f42243 100644 --- a/docs/types/classes/_validatorprefs_.validatorprefs.html +++ b/docs/types/classes/_validatorprefs_.validatorprefs.html @@ -2005,7 +2005,7 @@

constructor

⊕ new ValidatorPrefs(value?: ValidatorPrefsValue | Uint8Array): ValidatorPrefs

Overrides Struct.constructor

-

Defined in ValidatorPrefs.ts:21

+

Defined in ValidatorPrefs.ts:21

Parameters:

@@ -2029,7 +2029,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2037,21 +2037,21 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


unstakeThreshold

getunstakeThreshold(): U32

-

Defined in ValidatorPrefs.ts:32

+

Defined in ValidatorPrefs.ts:32

description: The unstake threshold as U32

Returns: U32


validatorPayment

getvalidatorPayment(): Balance

-

Defined in ValidatorPrefs.ts:39

+

Defined in ValidatorPrefs.ts:39

description: The payment config for the validator as Balance

Returns: Balance


@@ -2061,7 +2061,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2086,7 +2086,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2109,7 +2109,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2118,7 +2118,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2127,7 +2127,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2136,7 +2136,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2144,7 +2144,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2171,7 +2171,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2234,7 +2234,7 @@ diff --git a/docs/types/classes/_validatorprefs_.validatorprefs.md b/docs/types/classes/_validatorprefs_.validatorprefs.md index 811c65f718..ca62ce4353 100644 --- a/docs/types/classes/_validatorprefs_.validatorprefs.md +++ b/docs/types/classes/_validatorprefs_.validatorprefs.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [ValidatorPrefs.ts:21](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ValidatorPrefs.ts#L21)* +*Defined in [ValidatorPrefs.ts:21](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ValidatorPrefs.ts#L21)* **Parameters:** @@ -51,7 +51,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -66,7 +66,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -79,7 +79,7 @@ ___ getunstakeThreshold(): [U32](_u32_.u32.md) -*Defined in [ValidatorPrefs.ts:32](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ValidatorPrefs.ts#L32)* +*Defined in [ValidatorPrefs.ts:32](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ValidatorPrefs.ts#L32)* *__description__*: The unstake threshold as [U32](_u32_.u32.md) @@ -92,7 +92,7 @@ ___ getvalidatorPayment(): [Balance](_balance_.balance.md) -*Defined in [ValidatorPrefs.ts:39](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ValidatorPrefs.ts#L39)* +*Defined in [ValidatorPrefs.ts:39](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ValidatorPrefs.ts#L39)* *__description__*: The payment config for the validator as [Balance](_balance_.balance.md) @@ -112,7 +112,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -133,7 +133,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -154,7 +154,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -171,7 +171,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -188,7 +188,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -205,7 +205,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -220,7 +220,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -241,7 +241,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_vote_.vote.md b/docs/types/classes/_vote_.vote.md index 1181f1911b..3e3f76812b 100644 --- a/docs/types/classes/_vote_.vote.md +++ b/docs/types/classes/_vote_.vote.md @@ -26,7 +26,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [I8.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/I8.ts#L14)* +*Defined in [I8.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/I8.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -69,7 +69,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_voteindex_.voteindex.html b/docs/types/classes/_voteindex_.voteindex.html index c9337cede2..728649aa88 100644 --- a/docs/types/classes/_voteindex_.voteindex.html +++ b/docs/types/classes/_voteindex_.voteindex.html @@ -2001,7 +2001,7 @@

⊕ new VoteIndex(value?: AnyNumber): VoteIndex

Inherited from U32.constructor

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -2026,7 +2026,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -2035,7 +2035,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2101,7 +2101,7 @@ diff --git a/docs/types/classes/_voteindex_.voteindex.md b/docs/types/classes/_voteindex_.voteindex.md index 9b60f3833d..1676f5535f 100644 --- a/docs/types/classes/_voteindex_.voteindex.md +++ b/docs/types/classes/_voteindex_.voteindex.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/U32.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -69,7 +69,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_votethreshold_.votethreshold.html b/docs/types/classes/_votethreshold_.votethreshold.html index fdaf43faf3..dec0fe6e39 100644 --- a/docs/types/classes/_votethreshold_.votethreshold.html +++ b/docs/types/classes/_votethreshold_.votethreshold.html @@ -1998,7 +1998,7 @@

constructor

⊕ new VoteThreshold(index?: number | Uint8Array): VoteThreshold

Overrides Enum.constructor

-

Defined in VoteThreshold.ts:12

+

Defined in VoteThreshold.ts:12

Parameters:

@@ -2022,7 +2022,7 @@

encodedLength

getencodedLength(): number

Inherited from Enum.encodedLength

-

Defined in codec/Enum.ts:64

+

Defined in codec/Enum.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2032,7 +2032,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Enum.toHex

-

Defined in codec/Enum.ts:71

+

Defined in codec/Enum.ts:71

description: Returns a hex string representation of the value

Returns: string


@@ -2041,7 +2041,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Enum.toJSON

-

Defined in codec/Enum.ts:78

+

Defined in codec/Enum.ts:78

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2049,7 +2049,7 @@

toNumber

▸ toNumber(): number

Inherited from Enum.toNumber

-

Defined in codec/Enum.ts:85

+

Defined in codec/Enum.ts:85

description: Returns the number representation for the value

Returns: number


@@ -2058,7 +2058,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Enum.toString

-

Defined in codec/Enum.ts:92

+

Defined in codec/Enum.ts:92

description: Returns the string representation of the value

Returns: string


@@ -2066,7 +2066,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Enum.toU8a

-

Defined in codec/Enum.ts:100

+

Defined in codec/Enum.ts:100

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2093,7 +2093,7 @@

<Static> decodeEnum

▸ decodeEnum(def: EnumDef, value: Enum | Uint8Array | string | number): number | undefined

Inherited from Enum.decodeEnum

-

Defined in codec/Enum.ts:47

+

Defined in codec/Enum.ts:47

Parameters:

@@ -2157,7 +2157,7 @@ diff --git a/docs/types/classes/_votethreshold_.votethreshold.md b/docs/types/classes/_votethreshold_.votethreshold.md index e4cfd57a4f..7428e71f73 100644 --- a/docs/types/classes/_votethreshold_.votethreshold.md +++ b/docs/types/classes/_votethreshold_.votethreshold.md @@ -24,7 +24,7 @@ *Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* -*Defined in [VoteThreshold.ts:12](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/VoteThreshold.ts#L12)* +*Defined in [VoteThreshold.ts:12](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/VoteThreshold.ts#L12)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from [Enum](_codec_enum_.enum.md).[encodedLength](_codec_enum_.enum.md#encodedlength)* -*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L64)* +*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toHex](_codec_enum_.enum.md#tohex)* -*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L71)* +*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L71)* *__description__*: Returns a hex string representation of the value @@ -83,7 +83,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toJSON](_codec_enum_.enum.md#tojson)* -*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L78)* +*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L78)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -98,7 +98,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* -*Defined in [codec/Enum.ts:85](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L85)* +*Defined in [codec/Enum.ts:85](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L85)* *__description__*: Returns the number representation for the value @@ -115,7 +115,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toString](_codec_enum_.enum.md#tostring)* -*Defined in [codec/Enum.ts:92](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L92)* +*Defined in [codec/Enum.ts:92](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L92)* *__description__*: Returns the string representation of the value @@ -130,7 +130,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toU8a](_codec_enum_.enum.md#tou8a)* -*Defined in [codec/Enum.ts:100](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L100)* +*Defined in [codec/Enum.ts:100](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L100)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -151,7 +151,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[decodeEnum](_codec_enum_.enum.md#decodeenum)* -*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/Enum.ts#L47)* +*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/Enum.ts#L47)* **Parameters:** diff --git a/docs/types/enums/_codec_createtype_.typedefinfo.md b/docs/types/enums/_codec_createtype_.typedefinfo.md index 672acf3e19..006c9bf8ff 100644 --- a/docs/types/enums/_codec_createtype_.typedefinfo.md +++ b/docs/types/enums/_codec_createtype_.typedefinfo.md @@ -21,7 +21,7 @@ **Compact**: -*Defined in [codec/createType.ts:18](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/createType.ts#L18)* +*Defined in [codec/createType.ts:18](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/createType.ts#L18)* ___ @@ -30,7 +30,7 @@ ___ **Option**: -*Defined in [codec/createType.ts:19](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/createType.ts#L19)* +*Defined in [codec/createType.ts:19](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/createType.ts#L19)* ___ @@ -39,7 +39,7 @@ ___ **Plain**: -*Defined in [codec/createType.ts:20](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/createType.ts#L20)* +*Defined in [codec/createType.ts:20](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/createType.ts#L20)* ___ @@ -48,7 +48,7 @@ ___ **Struct**: -*Defined in [codec/createType.ts:21](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/createType.ts#L21)* +*Defined in [codec/createType.ts:21](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/createType.ts#L21)* ___ @@ -57,7 +57,7 @@ ___ **Tuple**: -*Defined in [codec/createType.ts:22](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/createType.ts#L22)* +*Defined in [codec/createType.ts:22](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/createType.ts#L22)* ___ @@ -66,7 +66,7 @@ ___ **Vector**: -*Defined in [codec/createType.ts:23](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/createType.ts#L23)* +*Defined in [codec/createType.ts:23](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/createType.ts#L23)* ___ diff --git a/docs/types/index.html b/docs/types/index.html index 604e15acfe..275ca60a6a 100644 --- a/docs/types/index.html +++ b/docs/types/index.html @@ -2035,7 +2035,7 @@ diff --git a/docs/types/interfaces/_method_.methodfunction.md b/docs/types/interfaces/_method_.methodfunction.md index 9a0412f718..64434bbb65 100644 --- a/docs/types/interfaces/_method_.methodfunction.md +++ b/docs/types/interfaces/_method_.methodfunction.md @@ -7,7 +7,7 @@ # Callable ▸ **__call**(...args: *`any`[]*): [Method](../classes/_method_.method.md) -*Defined in [Method.ts:28](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L28)* +*Defined in [Method.ts:28](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L28)* **Parameters:** @@ -25,7 +25,7 @@ **● callIndex**: *`Uint8Array`* -*Defined in [Method.ts:30](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L30)* +*Defined in [Method.ts:30](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L30)* ___ @@ -34,7 +34,7 @@ ___ **● meta**: *[FunctionMetadata](../classes/_metadata_modules_.functionmetadata.md)* -*Defined in [Method.ts:31](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L31)* +*Defined in [Method.ts:31](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L31)* ___ @@ -43,7 +43,7 @@ ___ **● method**: *`string`* -*Defined in [Method.ts:32](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L32)* +*Defined in [Method.ts:32](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L32)* ___ @@ -52,7 +52,7 @@ ___ **● section**: *`string`* -*Defined in [Method.ts:33](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L33)* +*Defined in [Method.ts:33](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L33)* ___ @@ -61,7 +61,7 @@ ___ **● toJSON**: *`function`* -*Defined in [Method.ts:34](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Method.ts#L34)* +*Defined in [Method.ts:34](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Method.ts#L34)* #### Type declaration ▸(): `any` diff --git a/docs/types/interfaces/_storagekey_.storagefunction.md b/docs/types/interfaces/_storagekey_.storagefunction.md index 0e53ce7126..6811445891 100644 --- a/docs/types/interfaces/_storagekey_.storagefunction.md +++ b/docs/types/interfaces/_storagekey_.storagefunction.md @@ -7,7 +7,7 @@ # Callable ▸ **__call**(arg?: *`any`*): `Uint8Array` -*Defined in [StorageKey.ts:12](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageKey.ts#L12)* +*Defined in [StorageKey.ts:12](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageKey.ts#L12)* **Parameters:** @@ -25,7 +25,7 @@ **● meta**: *[StorageFunctionMetadata](../classes/_metadata_modules_.storagefunctionmetadata.md)* -*Defined in [StorageKey.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageKey.ts#L14)* +*Defined in [StorageKey.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageKey.ts#L14)* ___ @@ -34,7 +34,7 @@ ___ **● method**: *`string`* -*Defined in [StorageKey.ts:15](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageKey.ts#L15)* +*Defined in [StorageKey.ts:15](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageKey.ts#L15)* ___ @@ -43,7 +43,7 @@ ___ **● section**: *`string`* -*Defined in [StorageKey.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageKey.ts#L16)* +*Defined in [StorageKey.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageKey.ts#L16)* ___ @@ -52,7 +52,7 @@ ___ **● toJSON**: *`function`* -*Defined in [StorageKey.ts:17](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StorageKey.ts#L17)* +*Defined in [StorageKey.ts:17](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StorageKey.ts#L17)* #### Type declaration ▸(): `any` diff --git a/docs/types/interfaces/_types_.codec.md b/docs/types/interfaces/_types_.codec.md index df1e962aa5..b0586edfc5 100644 --- a/docs/types/interfaces/_types_.codec.md +++ b/docs/types/interfaces/_types_.codec.md @@ -161,7 +161,7 @@ **● encodedLength**: *`number`* -*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/types.ts#L24)* *__description__*: The length of the value when encoded as a Uint8Array @@ -175,7 +175,7 @@ ___ ▸ **toHex**(): `string` -*Defined in [types.ts:29](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/types.ts#L29)* +*Defined in [types.ts:29](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/types.ts#L29)* *__description__*: Returns a hex string representation of the value @@ -188,7 +188,7 @@ ___ ▸ **toJSON**(): `any` -*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/types.ts#L34)* +*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/types.ts#L34)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -201,7 +201,7 @@ ___ ▸ **toString**(): `string` -*Defined in [types.ts:39](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/types.ts#L39)* +*Defined in [types.ts:39](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/types.ts#L39)* *__description__*: Returns the string representation of the value @@ -214,7 +214,7 @@ ___ ▸ **toU8a**(isBare?: *`undefined` | `false` | `true`*, isStorageKey?: *`undefined` | `false` | `true`*): `Uint8Array` -*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/types.ts#L46)* +*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/types.ts#L46)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/modules/_accountindex_.md b/docs/types/modules/_accountindex_.md index 738c00e55e..545a60661a 100644 --- a/docs/types/modules/_accountindex_.md +++ b/docs/types/modules/_accountindex_.md @@ -20,7 +20,7 @@ **● ENUMSET_SIZE**: *`BN`* = new BN(64) -*Defined in [AccountIndex.ts:13](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/AccountIndex.ts#L13)* +*Defined in [AccountIndex.ts:13](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/AccountIndex.ts#L13)* ___ diff --git a/docs/types/modules/_address_.md b/docs/types/modules/_address_.md index 881f2bc0cf..5a1057eda7 100644 --- a/docs/types/modules/_address_.md +++ b/docs/types/modules/_address_.md @@ -20,7 +20,7 @@ **● ACCOUNT_ID_PREFIX**: *`Uint8Array`* = new Uint8Array([0xff]) -*Defined in [Address.ts:15](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Address.ts#L15)* +*Defined in [Address.ts:15](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Address.ts#L15)* ___ diff --git a/docs/types/modules/_bft_.md b/docs/types/modules/_bft_.md index 39a0653887..2928173907 100644 --- a/docs/types/modules/_bft_.md +++ b/docs/types/modules/_bft_.md @@ -22,7 +22,7 @@ **Ƭ BftAuthoritySignatureValue**: *[[AnyU8a](_types_.md#anyu8a), [AnyU8a](_types_.md#anyu8a)]* -*Defined in [Bft.ts:12](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bft.ts#L12)* +*Defined in [Bft.ts:12](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bft.ts#L12)* ___ @@ -31,7 +31,7 @@ ___ **Ƭ BftHashSignatureValue**: *[[AnyU8a](_types_.md#anyu8a), [AnyU8a](_types_.md#anyu8a)]* -*Defined in [Bft.ts:43](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Bft.ts#L43)* +*Defined in [Bft.ts:43](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Bft.ts#L43)* ___ diff --git a/docs/types/modules/_block_.md b/docs/types/modules/_block_.md index e49459021e..12682aa3dd 100644 --- a/docs/types/modules/_block_.md +++ b/docs/types/modules/_block_.md @@ -20,7 +20,7 @@ **Ƭ BlockValue**: *`object`* -*Defined in [Block.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Block.ts#L14)* +*Defined in [Block.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Block.ts#L14)* #### Type declaration diff --git a/docs/types/modules/_classes_.md b/docs/types/modules/_classes_.md index 3a63cd68a8..1f57e5bed6 100644 --- a/docs/types/modules/_classes_.md +++ b/docs/types/modules/_classes_.md @@ -8,7 +8,7 @@ **Ƭ CodecTypes**: *`keyof "/home/travis/build/polkadot-js/api/packages/types/src/index"`* -*Defined in [classes.ts:7](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/classes.ts#L7)* +*Defined in [classes.ts:7](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/classes.ts#L7)* ___ diff --git a/docs/types/modules/_codec_abstractint_.md b/docs/types/modules/_codec_abstractint_.md index f9936801ad..cb4599b14c 100644 --- a/docs/types/modules/_codec_abstractint_.md +++ b/docs/types/modules/_codec_abstractint_.md @@ -8,7 +8,7 @@ **Ƭ UIntBitLength**: *`8` | `16` | `32` | `64` | `128` | `256`* -*Defined in [codec/AbstractInt.ts:10](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/AbstractInt.ts#L10)* +*Defined in [codec/AbstractInt.ts:10](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/AbstractInt.ts#L10)* ___ @@ -20,7 +20,7 @@ ___ **● DEFAULT_UINT_BITS**: *`64`* = 64 -*Defined in [codec/AbstractInt.ts:12](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/AbstractInt.ts#L12)* +*Defined in [codec/AbstractInt.ts:12](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/AbstractInt.ts#L12)* ___ diff --git a/docs/types/modules/_codec_createtype_.md b/docs/types/modules/_codec_createtype_.md index 0585482d1c..bc8c29f375 100644 --- a/docs/types/modules/_codec_createtype_.md +++ b/docs/types/modules/_codec_createtype_.md @@ -28,7 +28,7 @@ **Ƭ TypeDef**: *`object`* -*Defined in [codec/createType.ts:26](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/createType.ts#L26)* +*Defined in [codec/createType.ts:26](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/createType.ts#L26)* #### Type declaration @@ -42,7 +42,7 @@ ___ ▸ **createClass**(type: *[Text](../classes/_text_.text.md) | `string`*, value?: *`any`*): [Constructor](_types_.md#constructor) -*Defined in [codec/createType.ts:172](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/createType.ts#L172)* +*Defined in [codec/createType.ts:172](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/createType.ts#L172)* **Parameters:** @@ -60,7 +60,7 @@ ___ ▸ **createType**(type: *[Text](../classes/_text_.text.md) | `string`*, value?: *`any`*): [Codec](../interfaces/_types_.codec.md) -*Defined in [codec/createType.ts:178](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/createType.ts#L178)* +*Defined in [codec/createType.ts:178](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/createType.ts#L178)* **Parameters:** @@ -78,7 +78,7 @@ ___ ▸ **getTypeClass**(value: *[TypeDef](_codec_createtype_.md#typedef)*): [Constructor](_types_.md#constructor) -*Defined in [codec/createType.ts:126](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/createType.ts#L126)* +*Defined in [codec/createType.ts:126](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/createType.ts#L126)* **Parameters:** @@ -95,7 +95,7 @@ ___ ▸ **getTypeDef**(_type: *[Text](../classes/_text_.text.md) | `string`*, name?: *`undefined` | `string`*): [TypeDef](_codec_createtype_.md#typedef) -*Defined in [codec/createType.ts:82](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/createType.ts#L82)* +*Defined in [codec/createType.ts:82](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/createType.ts#L82)* **Parameters:** @@ -113,7 +113,7 @@ ___ ▸ **typeSplit**(type: *`string`*): `Array`<`string`> -*Defined in [codec/createType.ts:34](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/createType.ts#L34)* +*Defined in [codec/createType.ts:34](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/createType.ts#L34)* **Parameters:** diff --git a/docs/types/modules/_codec_utils_decodeu8a_.md b/docs/types/modules/_codec_utils_decodeu8a_.md index d724f47c17..2aa798df44 100644 --- a/docs/types/modules/_codec_utils_decodeu8a_.md +++ b/docs/types/modules/_codec_utils_decodeu8a_.md @@ -8,7 +8,7 @@ ▸ **decodeU8a**(u8a: *`Uint8Array`*, _types: *[Constructor](_types_.md#constructor)[] | `object`*): [Codec](../interfaces/_types_.codec.md)[] -*Defined in [codec/utils/decodeU8a.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/codec/utils/decodeU8a.ts#L14)* +*Defined in [codec/utils/decodeU8a.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/codec/utils/decodeU8a.ts#L14)* Given an u8a, and an array of Type constructors, decode the u8a against the types, and return an array of decoded values. diff --git a/docs/types/modules/_extrinsicsignature_.md b/docs/types/modules/_extrinsicsignature_.md index d331896210..ab2f47938b 100644 --- a/docs/types/modules/_extrinsicsignature_.md +++ b/docs/types/modules/_extrinsicsignature_.md @@ -20,7 +20,7 @@ **● IMMORTAL_ERA**: *`Uint8Array`* = new Uint8Array([0]) -*Defined in [ExtrinsicSignature.ts:25](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/ExtrinsicSignature.ts#L25)* +*Defined in [ExtrinsicSignature.ts:25](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/ExtrinsicSignature.ts#L25)* ___ diff --git a/docs/types/modules/_header_.md b/docs/types/modules/_header_.md index 46aca55492..7d03b6a332 100644 --- a/docs/types/modules/_header_.md +++ b/docs/types/modules/_header_.md @@ -20,7 +20,7 @@ **Ƭ HeaderValue**: *`object`* -*Defined in [Header.ts:16](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Header.ts#L16)* +*Defined in [Header.ts:16](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Header.ts#L16)* #### Type declaration diff --git a/docs/types/modules/_justification_.md b/docs/types/modules/_justification_.md index 8b71c763c2..fb2d3cf19a 100644 --- a/docs/types/modules/_justification_.md +++ b/docs/types/modules/_justification_.md @@ -21,7 +21,7 @@ **Ƭ RhdJustificationValue**: *`object`* -*Defined in [Justification.ts:14](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/Justification.ts#L14)* +*Defined in [Justification.ts:14](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/Justification.ts#L14)* #### Type declaration diff --git a/docs/types/modules/_keyvalue_.md b/docs/types/modules/_keyvalue_.md index 0bec595c8d..328849834e 100644 --- a/docs/types/modules/_keyvalue_.md +++ b/docs/types/modules/_keyvalue_.md @@ -21,7 +21,7 @@ **Ƭ KeyValueOptionValue**: *[[AnyU8a](_types_.md#anyu8a), `undefined` | `string` | `Uint8Array` | `number`[]]* -*Defined in [KeyValue.ts:49](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/KeyValue.ts#L49)* +*Defined in [KeyValue.ts:49](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/KeyValue.ts#L49)* ___ diff --git a/docs/types/modules/_storedpendingchange_.md b/docs/types/modules/_storedpendingchange_.md index b420bf64e8..2e032dcb85 100644 --- a/docs/types/modules/_storedpendingchange_.md +++ b/docs/types/modules/_storedpendingchange_.md @@ -22,7 +22,7 @@ **Ƭ NextAuthorityValue**: *`object`* -*Defined in [StoredPendingChange.ts:15](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StoredPendingChange.ts#L15)* +*Defined in [StoredPendingChange.ts:15](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StoredPendingChange.ts#L15)* #### Type declaration @@ -33,7 +33,7 @@ ___ **Ƭ StoredPendingChangeValue**: *`object`* -*Defined in [StoredPendingChange.ts:20](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/StoredPendingChange.ts#L20)* +*Defined in [StoredPendingChange.ts:20](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/StoredPendingChange.ts#L20)* #### Type declaration diff --git a/docs/types/modules/_types_.md b/docs/types/modules/_types_.md index 1f0829a29c..61c98dfc33 100644 --- a/docs/types/modules/_types_.md +++ b/docs/types/modules/_types_.md @@ -26,7 +26,7 @@ **Ƭ AnyNumber**: *`BN` | `Uint8Array` | `number` | `string`* -*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/types.ts#L7)* ___ @@ -35,7 +35,7 @@ ___ **Ƭ AnyString**: *`string` | `String`* -*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/types.ts#L9)* ___ @@ -44,7 +44,7 @@ ___ **Ƭ AnyU8a**: *`Uint8Array` | `Array`<`number`> | `string`* -*Defined in [types.ts:11](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/types.ts#L11)* +*Defined in [types.ts:11](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/types.ts#L11)* ___ @@ -53,7 +53,7 @@ ___ **Ƭ CodecTo**: *"toHex" | "toJSON" | "toString" | "toU8a"* -*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/types.ts#L49)* +*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/types.ts#L49)* ___ @@ -62,7 +62,7 @@ ___ **Ƭ Constructor**: *`object`* -*Defined in [types.ts:51](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/types.ts#L51)* +*Defined in [types.ts:51](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/types.ts#L51)* #### Type declaration @@ -73,7 +73,7 @@ ___ **Ƭ ConstructorDef**: *`object`* -*Defined in [types.ts:53](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/types.ts#L53)* +*Defined in [types.ts:53](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/types.ts#L53)* #### Type declaration @@ -86,7 +86,7 @@ ___ **Ƭ TypeDef**: *`object`* -*Defined in [types.ts:55](https://github.com/polkadot-js/api/blob/bb7a5ac/packages/types/src/types.ts#L55)* +*Defined in [types.ts:55](https://github.com/polkadot-js/api/blob/132a8dd/packages/types/src/types.ts#L55)* #### Type declaration diff --git a/lerna.json b/lerna.json index 063a9bc2b4..4f2e6afb8e 100644 --- a/lerna.json +++ b/lerna.json @@ -9,5 +9,5 @@ "packages": [ "packages/*" ], - "version": "0.38.15" + "version": "0.38.16" } diff --git a/package.json b/package.json index 357313eec0..87ecc01fb1 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "version": "0.38.15", + "version": "0.38.16", "private": true, "engines": { "node": "^10.13.0", diff --git a/packages/api-derive/package.json b/packages/api-derive/package.json index 04d974be9f..e0443f27f3 100644 --- a/packages/api-derive/package.json +++ b/packages/api-derive/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/api-derive", - "version": "0.38.15", + "version": "0.38.16", "description": "Common functions used across Polkadot, derived from RPC calls and storage queries.", "main": "index.js", "keywords": [ @@ -31,8 +31,8 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api-derive#readme", "dependencies": { "@babel/runtime": "^7.2.0", - "@polkadot/api": "^0.38.15", - "@polkadot/types": "^0.38.15", + "@polkadot/api": "^0.38.16", + "@polkadot/types": "^0.38.16", "@types/memoizee": "^0.4.2", "@types/rx": "^4.1.1", "memoizee": "^0.4.14", diff --git a/packages/api/package.json b/packages/api/package.json index cb271ed15d..a88d6b7dc7 100644 --- a/packages/api/package.json +++ b/packages/api/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/api", - "version": "0.38.15", + "version": "0.38.16", "description": "An RxJS wrapper around the Polkadot JS RPC", "main": "index.js", "keywords": [ @@ -30,12 +30,12 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api#readme", "dependencies": { "@babel/runtime": "^7.2.0", - "@polkadot/api-derive": "^0.38.15", - "@polkadot/extrinsics": "^0.38.15", - "@polkadot/rpc-provider": "^0.38.15", - "@polkadot/rpc-rx": "^0.38.15", - "@polkadot/storage": "^0.38.15", - "@polkadot/types": "^0.38.15", + "@polkadot/api-derive": "^0.38.16", + "@polkadot/extrinsics": "^0.38.16", + "@polkadot/rpc-provider": "^0.38.16", + "@polkadot/rpc-rx": "^0.38.16", + "@polkadot/storage": "^0.38.16", + "@polkadot/types": "^0.38.16", "@types/rx": "^4.1.1", "rxjs": "^6.3.3" } diff --git a/packages/rpc-core/package.json b/packages/rpc-core/package.json index c3e87beee5..10071e0cc8 100644 --- a/packages/rpc-core/package.json +++ b/packages/rpc-core/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-core", - "version": "0.38.15", + "version": "0.38.16", "description": "A JavaScript wrapper for the Polkadot JsonRPC interface", "main": "index.js", "keywords": [ @@ -30,9 +30,9 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-core#readme", "dependencies": { "@babel/runtime": "^7.2.0", - "@polkadot/jsonrpc": "^0.38.15", - "@polkadot/rpc-provider": "^0.38.15", - "@polkadot/types": "^0.38.15", + "@polkadot/jsonrpc": "^0.38.16", + "@polkadot/rpc-provider": "^0.38.16", + "@polkadot/types": "^0.38.16", "@polkadot/util": "^0.33.33" } } diff --git a/packages/rpc-provider/package.json b/packages/rpc-provider/package.json index 2ee64ac231..f6c7fb0cd3 100644 --- a/packages/rpc-provider/package.json +++ b/packages/rpc-provider/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-provider", - "version": "0.38.15", + "version": "0.38.16", "description": "Transport providers for the API", "main": "index.js", "keywords": [ @@ -31,7 +31,7 @@ "dependencies": { "@babel/runtime": "^7.2.0", "@polkadot/keyring": "^0.33.33", - "@polkadot/storage": "^0.38.15", + "@polkadot/storage": "^0.38.16", "@polkadot/util": "^0.33.33", "@polkadot/util-crypto": "^0.33.33", "@types/nock": "^9.3.0", diff --git a/packages/rpc-rx/package.json b/packages/rpc-rx/package.json index d73884d012..a761359917 100644 --- a/packages/rpc-rx/package.json +++ b/packages/rpc-rx/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-rx", - "version": "0.38.15", + "version": "0.38.16", "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/rpc-rx#readme", "dependencies": { "@babel/runtime": "^7.2.0", - "@polkadot/rpc-core": "^0.38.15", - "@polkadot/rpc-provider": "^0.38.15", + "@polkadot/rpc-core": "^0.38.16", + "@polkadot/rpc-provider": "^0.38.16", "@types/rx": "^4.1.1", "rxjs": "^6.3.3" } diff --git a/packages/type-extrinsics/package.json b/packages/type-extrinsics/package.json index e3845d2d04..fb305d1a50 100644 --- a/packages/type-extrinsics/package.json +++ b/packages/type-extrinsics/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/extrinsics", - "version": "0.38.15", + "version": "0.38.16", "main": "index.js", "repository": "https://github.com/polkadot-js/api.git", "author": "Jaco Greeff ", @@ -11,7 +11,7 @@ "license": "Apache-2.0", "dependencies": { "@babel/runtime": "^7.2.0", - "@polkadot/types": "^0.38.15", + "@polkadot/types": "^0.38.16", "@polkadot/util": "^0.33.33" } } diff --git a/packages/type-jsonrpc/package.json b/packages/type-jsonrpc/package.json index 9b84532ae5..d5c37f657e 100644 --- a/packages/type-jsonrpc/package.json +++ b/packages/type-jsonrpc/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/jsonrpc", - "version": "0.38.15", + "version": "0.38.16", "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 662ce970d9..3633be78fa 100644 --- a/packages/type-storage/package.json +++ b/packages/type-storage/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/storage", - "version": "0.38.15", + "version": "0.38.16", "description": "Generic wrapper wrapper around state storage", "main": "index.js", "engines": { @@ -31,7 +31,7 @@ "dependencies": { "@babel/runtime": "^7.2.0", "@polkadot/keyring": "^0.33.33", - "@polkadot/types": "^0.38.15", + "@polkadot/types": "^0.38.16", "@polkadot/util": "^0.33.33", "@polkadot/util-crypto": "^0.33.33" } diff --git a/packages/types/package.json b/packages/types/package.json index e549db5746..25e4bc5181 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/types", - "version": "0.38.15", + "version": "0.38.16", "description": "Implementation of the Parity codec", "main": "index.js", "keywords": [