diff --git a/docs/GLOSSARY.html b/docs/GLOSSARY.html index 5a05a16219..7c35f45725 100644 --- a/docs/GLOSSARY.html +++ b/docs/GLOSSARY.html @@ -2168,7 +2168,7 @@ diff --git a/docs/METHODS_EVENTS.html b/docs/METHODS_EVENTS.html index d1e69ec40a..696e997fdb 100644 --- a/docs/METHODS_EVENTS.html +++ b/docs/METHODS_EVENTS.html @@ -2390,7 +2390,7 @@ diff --git a/docs/METHODS_EXTRINSICS.html b/docs/METHODS_EXTRINSICS.html index 1f8fa17ef0..03f55a9bf4 100644 --- a/docs/METHODS_EXTRINSICS.html +++ b/docs/METHODS_EXTRINSICS.html @@ -2445,7 +2445,7 @@ diff --git a/docs/METHODS_RPC.html b/docs/METHODS_RPC.html index 703a1100d6..2ca03c105d 100644 --- a/docs/METHODS_RPC.html +++ b/docs/METHODS_RPC.html @@ -2306,7 +2306,7 @@ diff --git a/docs/METHODS_STORAGE.html b/docs/METHODS_STORAGE.html index a9d3e3c9e2..57e98b985e 100644 --- a/docs/METHODS_STORAGE.html +++ b/docs/METHODS_STORAGE.html @@ -2724,7 +2724,7 @@ diff --git a/docs/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.md b/docs/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.md index 1804c64ef7..eb9de1059b 100644 --- a/docs/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.md +++ b/docs/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.md @@ -29,7 +29,7 @@ *Overrides ReferendumInfo.__constructor* -*Defined in [democracy/referendumInfo.ts:18](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/democracy/referendumInfo.ts#L18)* +*Defined in [democracy/referendumInfo.ts:18](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/democracy/referendumInfo.ts#L18)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from Struct.Type* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -91,7 +91,7 @@ getdelay(): `BlockNumber` *Inherited from ReferendumInfo.delay* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ReferendumInfo.ts#L58)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ReferendumInfo.ts#L58)* *__description__*: The delay (in blocks) to wait after a successful referendum before deploying @@ -106,7 +106,7 @@ getencodedLength(): `number` *Inherited from Struct.encodedLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -121,7 +121,7 @@ getend(): `BlockNumber` *Inherited from ReferendumInfo.end* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:37](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ReferendumInfo.ts#L37)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:37](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ReferendumInfo.ts#L37)* *__description__*: When voting on this referendum will end @@ -134,7 +134,7 @@ ___ getindex(): `ReferendumIndex` -*Defined in [democracy/referendumInfo.ts:28](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/democracy/referendumInfo.ts#L28)* +*Defined in [democracy/referendumInfo.ts:28](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/democracy/referendumInfo.ts#L28)* *__description__*: Convenience getter, returns the referendumIndex @@ -149,7 +149,7 @@ getisEmpty(): `boolean` *Inherited from Struct.isEmpty* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -164,7 +164,7 @@ getproposal(): `Proposal` *Inherited from ReferendumInfo.proposal* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:44](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ReferendumInfo.ts#L44)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:44](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ReferendumInfo.ts#L44)* *__description__*: The proposal being voted on @@ -179,7 +179,7 @@ getthreshold(): `VoteThreshold` *Inherited from ReferendumInfo.threshold* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:51](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ReferendumInfo.ts#L51)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:51](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ReferendumInfo.ts#L51)* *__description__*: The thresholding mechanism to determine whether it passed @@ -259,7 +259,7 @@ ___ *Inherited from Struct.eq* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -302,7 +302,7 @@ ___ *Overrides Map.get* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -323,7 +323,7 @@ ___ *Inherited from Struct.getAtIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -398,7 +398,7 @@ ___ *Inherited from Struct.toArray* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -413,7 +413,7 @@ ___ *Inherited from Struct.toHex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -428,7 +428,7 @@ ___ *Inherited from Struct.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -443,7 +443,7 @@ ___ *Inherited from Struct.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -458,7 +458,7 @@ ___ *Inherited from Struct.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -494,7 +494,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/api-derive/interfaces/_index_.derive.md b/docs/api-derive/interfaces/_index_.derive.md index c22833edcc..2745582f91 100644 --- a/docs/api-derive/interfaces/_index_.derive.md +++ b/docs/api-derive/interfaces/_index_.derive.md @@ -12,7 +12,7 @@ **● accounts**: *`ReturnTypes`<["accounts/index"](../modules/_accounts_index_.md)>* -*Defined in [index.ts:38](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/index.ts#L38)* +*Defined in [index.ts:38](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/index.ts#L38)* ___ @@ -21,7 +21,7 @@ ___ **● balances**: *`ReturnTypes`<["balances/index"](../modules/_balances_index_.md)>* -*Defined in [index.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/index.ts#L39)* +*Defined in [index.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/index.ts#L39)* ___ @@ -30,7 +30,7 @@ ___ **● chain**: *`ReturnTypes`<["chain/index"](../modules/_chain_index_.md)>* -*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/index.ts#L40)* +*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/index.ts#L40)* ___ @@ -39,7 +39,7 @@ ___ **● democracy**: *`ReturnTypes`<["democracy/index"](../modules/_democracy_index_.md)>* -*Defined in [index.ts:41](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/index.ts#L41)* +*Defined in [index.ts:41](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/index.ts#L41)* ___ @@ -48,7 +48,7 @@ ___ **● session**: *`ReturnTypes`<["session/index"](../modules/_session_index_.md)>* -*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/index.ts#L42)* +*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/index.ts#L42)* ___ @@ -57,7 +57,7 @@ ___ **● staking**: *`ReturnTypes`<["staking/index"](../modules/_staking_index_.md)>* -*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/index.ts#L43)* +*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/index.ts#L43)* ___ diff --git a/docs/api-derive/interfaces/_index_.derivecustommethod.md b/docs/api-derive/interfaces/_index_.derivecustommethod.md index 867ff7728e..996e8d0b10 100644 --- a/docs/api-derive/interfaces/_index_.derivecustommethod.md +++ b/docs/api-derive/interfaces/_index_.derivecustommethod.md @@ -7,7 +7,7 @@ # Callable ▸ **__call**(api: *`ApiInterface$Rx`*): `function` -*Defined in [index.ts:27](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/index.ts#L27)* +*Defined in [index.ts:27](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/index.ts#L27)* **Parameters:** diff --git a/docs/api-derive/modules/_accounts_idandindex_.md b/docs/api-derive/modules/_accounts_idandindex_.md index 6f0e9b0bdc..6ac3ddb132 100644 --- a/docs/api-derive/modules/_accounts_idandindex_.md +++ b/docs/api-derive/modules/_accounts_idandindex_.md @@ -8,7 +8,7 @@ **Ƭ AccountIdAndIndex**: *[`undefined` \| `AccountId`, `undefined` \| `AccountIndex`]* -*Defined in [accounts/idAndIndex.ts:16](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/accounts/idAndIndex.ts#L16)* +*Defined in [accounts/idAndIndex.ts:16](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/accounts/idAndIndex.ts#L16)* ___ @@ -20,7 +20,7 @@ ___ ▸ **idAndIndex**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [accounts/idAndIndex.ts:18](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/accounts/idAndIndex.ts#L18)* +*Defined in [accounts/idAndIndex.ts:18](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/accounts/idAndIndex.ts#L18)* **Parameters:** diff --git a/docs/api-derive/modules/_accounts_idtoindex_.md b/docs/api-derive/modules/_accounts_idtoindex_.md index 692f95d328..b2ac076156 100644 --- a/docs/api-derive/modules/_accounts_idtoindex_.md +++ b/docs/api-derive/modules/_accounts_idtoindex_.md @@ -8,7 +8,7 @@ ▸ **idToIndex**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [accounts/idToIndex.ts:13](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/accounts/idToIndex.ts#L13)* +*Defined in [accounts/idToIndex.ts:13](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/accounts/idToIndex.ts#L13)* **Parameters:** diff --git a/docs/api-derive/modules/_accounts_indexes_.md b/docs/api-derive/modules/_accounts_indexes_.md index 6c831ece72..300c1932ee 100644 --- a/docs/api-derive/modules/_accounts_indexes_.md +++ b/docs/api-derive/modules/_accounts_indexes_.md @@ -8,7 +8,7 @@ **Ƭ AccountIndexes**: *`object`* -*Defined in [accounts/indexes.ts:13](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/accounts/indexes.ts#L13)* +*Defined in [accounts/indexes.ts:13](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/accounts/indexes.ts#L13)* #### Type declaration @@ -24,7 +24,7 @@ ___ ▸ **indexes**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [accounts/indexes.ts:15](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/accounts/indexes.ts#L15)* +*Defined in [accounts/indexes.ts:15](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/accounts/indexes.ts#L15)* **Parameters:** diff --git a/docs/api-derive/modules/_accounts_indextoid_.md b/docs/api-derive/modules/_accounts_indextoid_.md index 66976c38e9..1a17197d3a 100644 --- a/docs/api-derive/modules/_accounts_indextoid_.md +++ b/docs/api-derive/modules/_accounts_indextoid_.md @@ -8,7 +8,7 @@ ▸ **indexToId**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [accounts/indexToId.ts:13](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/accounts/indexToId.ts#L13)* +*Defined in [accounts/indexToId.ts:13](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/accounts/indexToId.ts#L13)* **Parameters:** diff --git a/docs/api-derive/modules/_balances_fees_.md b/docs/api-derive/modules/_balances_fees_.md index 7958dec243..658efe9d24 100644 --- a/docs/api-derive/modules/_balances_fees_.md +++ b/docs/api-derive/modules/_balances_fees_.md @@ -8,7 +8,7 @@ ▸ **fees**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [balances/fees.ts:13](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/balances/fees.ts#L13)* +*Defined in [balances/fees.ts:13](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/balances/fees.ts#L13)* **Parameters:** diff --git a/docs/api-derive/modules/_balances_validatingbalance_.md b/docs/api-derive/modules/_balances_validatingbalance_.md index 8f367e95db..12845d111e 100644 --- a/docs/api-derive/modules/_balances_validatingbalance_.md +++ b/docs/api-derive/modules/_balances_validatingbalance_.md @@ -8,7 +8,7 @@ ▸ **validatingBalance**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [balances/validatingBalance.ts:16](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/balances/validatingBalance.ts#L16)* +*Defined in [balances/validatingBalance.ts:16](https://github.com/polkadot-js/api/blob/6eb859c/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 58ef971799..6ae6f160b6 100644 --- a/docs/api-derive/modules/_balances_validatingbalances_.md +++ b/docs/api-derive/modules/_balances_validatingbalances_.md @@ -8,7 +8,7 @@ ▸ **validatingBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [balances/validatingBalances.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/balances/validatingBalances.ts#L14)* +*Defined in [balances/validatingBalances.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/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 9dfdae6dbb..b1efdad840 100644 --- a/docs/api-derive/modules/_balances_votingbalance_.md +++ b/docs/api-derive/modules/_balances_votingbalance_.md @@ -8,7 +8,7 @@ ▸ **votingBalance**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [balances/votingBalance.ts:16](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/balances/votingBalance.ts#L16)* +*Defined in [balances/votingBalance.ts:16](https://github.com/polkadot-js/api/blob/6eb859c/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 c0d3e38b6b..7cf8496251 100644 --- a/docs/api-derive/modules/_balances_votingbalances_.md +++ b/docs/api-derive/modules/_balances_votingbalances_.md @@ -8,7 +8,7 @@ ▸ **votingBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [balances/votingBalances.ts:13](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/balances/votingBalances.ts#L13)* +*Defined in [balances/votingBalances.ts:13](https://github.com/polkadot-js/api/blob/6eb859c/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 645e60ba7c..28c83a64b7 100644 --- a/docs/api-derive/modules/_balances_votingbalancesnominatorsfor_.md +++ b/docs/api-derive/modules/_balances_votingbalancesnominatorsfor_.md @@ -8,7 +8,7 @@ ▸ **votingBalancesNominatorsFor**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [balances/votingBalancesNominatorsFor.ts:15](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/balances/votingBalancesNominatorsFor.ts#L15)* +*Defined in [balances/votingBalancesNominatorsFor.ts:15](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/balances/votingBalancesNominatorsFor.ts#L15)* **Parameters:** diff --git a/docs/api-derive/modules/_chain_bestnumber_.md b/docs/api-derive/modules/_chain_bestnumber_.md index 05f67e837f..79c8ad4550 100644 --- a/docs/api-derive/modules/_chain_bestnumber_.md +++ b/docs/api-derive/modules/_chain_bestnumber_.md @@ -8,7 +8,7 @@ ▸ **bestNumber**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [chain/bestNumber.ts:23](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/chain/bestNumber.ts#L23)* +*Defined in [chain/bestNumber.ts:23](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/chain/bestNumber.ts#L23)* *__description__*: Get the latest block number. diff --git a/docs/api-derive/modules/_chain_bestnumberfinalised_.md b/docs/api-derive/modules/_chain_bestnumberfinalised_.md index a5143e1a7f..2e857fd89f 100644 --- a/docs/api-derive/modules/_chain_bestnumberfinalised_.md +++ b/docs/api-derive/modules/_chain_bestnumberfinalised_.md @@ -8,7 +8,7 @@ ▸ **bestNumberFinalised**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [chain/bestNumberFinalised.ts:23](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/chain/bestNumberFinalised.ts#L23)* +*Defined in [chain/bestNumberFinalised.ts:23](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/chain/bestNumberFinalised.ts#L23)* *__description__*: Get the latest finalised block number. example diff --git a/docs/api-derive/modules/_chain_bestnumberlag_.md b/docs/api-derive/modules/_chain_bestnumberlag_.md index c0efd88bd5..d6a143de60 100644 --- a/docs/api-derive/modules/_chain_bestnumberlag_.md +++ b/docs/api-derive/modules/_chain_bestnumberlag_.md @@ -8,7 +8,7 @@ ▸ **bestNumberLag**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [chain/bestNumberLag.ts:25](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/chain/bestNumberLag.ts#L25)* +*Defined in [chain/bestNumberLag.ts:25](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/chain/bestNumberLag.ts#L25)* *__description__*: Calculates the lag between finalised head and best head diff --git a/docs/api-derive/modules/_chain_getheader_.md b/docs/api-derive/modules/_chain_getheader_.md index 17c864dac2..95b31f87f3 100644 --- a/docs/api-derive/modules/_chain_getheader_.md +++ b/docs/api-derive/modules/_chain_getheader_.md @@ -8,7 +8,7 @@ ▸ **getHeader**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [chain/getHeader.ts:25](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/chain/getHeader.ts#L25)* +*Defined in [chain/getHeader.ts:25](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/chain/getHeader.ts#L25)* *__description__*: Get the a specific block header and extend it with the author diff --git a/docs/api-derive/modules/_chain_subscribenewhead_.md b/docs/api-derive/modules/_chain_subscribenewhead_.md index a982d4a4c0..0502e20c28 100644 --- a/docs/api-derive/modules/_chain_subscribenewhead_.md +++ b/docs/api-derive/modules/_chain_subscribenewhead_.md @@ -8,7 +8,7 @@ **Ƭ HeaderAndValidators**: *[`Header`, `Array`<`AccountId`>]* -*Defined in [chain/subscribeNewHead.ts:12](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/chain/subscribeNewHead.ts#L12)* +*Defined in [chain/subscribeNewHead.ts:12](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/chain/subscribeNewHead.ts#L12)* ___ @@ -20,7 +20,7 @@ ___ ▸ **subscribeNewHead**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [chain/subscribeNewHead.ts:25](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/chain/subscribeNewHead.ts#L25)* +*Defined in [chain/subscribeNewHead.ts:25](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/chain/subscribeNewHead.ts#L25)* *__description__*: Subscribe to block headers and extend it with the author diff --git a/docs/api-derive/modules/_democracy_referenduminfo_.md b/docs/api-derive/modules/_democracy_referenduminfo_.md index 2e953e9627..3f781ec5cd 100644 --- a/docs/api-derive/modules/_democracy_referenduminfo_.md +++ b/docs/api-derive/modules/_democracy_referenduminfo_.md @@ -20,7 +20,7 @@ ▸ **referendumInfo**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [democracy/referendumInfo.ts:33](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/democracy/referendumInfo.ts#L33)* +*Defined in [democracy/referendumInfo.ts:33](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/democracy/referendumInfo.ts#L33)* **Parameters:** diff --git a/docs/api-derive/modules/_democracy_referenduminfos_.md b/docs/api-derive/modules/_democracy_referenduminfos_.md index ad4a982524..9d718a03af 100644 --- a/docs/api-derive/modules/_democracy_referenduminfos_.md +++ b/docs/api-derive/modules/_democracy_referenduminfos_.md @@ -8,7 +8,7 @@ ▸ **referendumInfos**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [democracy/referendumInfos.ts:13](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/democracy/referendumInfos.ts#L13)* +*Defined in [democracy/referendumInfos.ts:13](https://github.com/polkadot-js/api/blob/6eb859c/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 446263ab09..57f8e449b8 100644 --- a/docs/api-derive/modules/_democracy_referendums_.md +++ b/docs/api-derive/modules/_democracy_referendums_.md @@ -8,7 +8,7 @@ ▸ **referendums**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [democracy/referendums.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/democracy/referendums.ts#L14)* +*Defined in [democracy/referendums.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/democracy/referendums.ts#L14)* **Parameters:** diff --git a/docs/api-derive/modules/_democracy_referendumvotesfor_.md b/docs/api-derive/modules/_democracy_referendumvotesfor_.md index ecd89c167b..9fb637a76a 100644 --- a/docs/api-derive/modules/_democracy_referendumvotesfor_.md +++ b/docs/api-derive/modules/_democracy_referendumvotesfor_.md @@ -8,7 +8,7 @@ ▸ **referendumVotesFor**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [democracy/referendumVotesFor.ts:16](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/democracy/referendumVotesFor.ts#L16)* +*Defined in [democracy/referendumVotesFor.ts:16](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/democracy/referendumVotesFor.ts#L16)* **Parameters:** diff --git a/docs/api-derive/modules/_democracy_votes_.md b/docs/api-derive/modules/_democracy_votes_.md index 1f948f8f09..0efe4e44a1 100644 --- a/docs/api-derive/modules/_democracy_votes_.md +++ b/docs/api-derive/modules/_democracy_votes_.md @@ -8,7 +8,7 @@ ▸ **votes**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [democracy/votes.ts:12](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/democracy/votes.ts#L12)* +*Defined in [democracy/votes.ts:12](https://github.com/polkadot-js/api/blob/6eb859c/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 1e009b8971..4e4737854f 100644 --- a/docs/api-derive/modules/_index_.md +++ b/docs/api-derive/modules/_index_.md @@ -22,7 +22,7 @@ ▸ **decorateDerive**(api: *`ApiInterface$Rx`*, custom?: *[DeriveCustom](../interfaces/_index_.derivecustom.md)*): [Derive](../interfaces/_index_.derive.md) -*Defined in [index.ts:65](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/index.ts#L65)* +*Defined in [index.ts:65](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/index.ts#L65)* **Parameters:** diff --git a/docs/api-derive/modules/_session_eralength_.md b/docs/api-derive/modules/_session_eralength_.md index ec1257ddac..8349053329 100644 --- a/docs/api-derive/modules/_session_eralength_.md +++ b/docs/api-derive/modules/_session_eralength_.md @@ -8,7 +8,7 @@ ▸ **eraLength**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [session/eraLength.ts:13](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/session/eraLength.ts#L13)* +*Defined in [session/eraLength.ts:13](https://github.com/polkadot-js/api/blob/6eb859c/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 7f2f9fb5d5..663e8c0d0e 100644 --- a/docs/api-derive/modules/_session_eraprogress_.md +++ b/docs/api-derive/modules/_session_eraprogress_.md @@ -8,7 +8,7 @@ ▸ **eraProgress**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [session/eraProgress.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/session/eraProgress.ts#L14)* +*Defined in [session/eraProgress.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/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 ad465d357b..3ecbc6843a 100644 --- a/docs/api-derive/modules/_session_sessionprogress_.md +++ b/docs/api-derive/modules/_session_sessionprogress_.md @@ -8,7 +8,7 @@ ▸ **sessionProgress**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [session/sessionProgress.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/session/sessionProgress.ts#L14)* +*Defined in [session/sessionProgress.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/session/sessionProgress.ts#L14)* **Parameters:** diff --git a/docs/api-derive/modules/_staking_intentionsbalances_.md b/docs/api-derive/modules/_staking_intentionsbalances_.md index 4383cdba96..6e546a76cb 100644 --- a/docs/api-derive/modules/_staking_intentionsbalances_.md +++ b/docs/api-derive/modules/_staking_intentionsbalances_.md @@ -8,7 +8,7 @@ ▸ **intentionsBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)` -*Defined in [staking/intentionsBalances.ts:17](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/staking/intentionsBalances.ts#L17)* +*Defined in [staking/intentionsBalances.ts:17](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/staking/intentionsBalances.ts#L17)* Get the balances for all intentions and their nominators diff --git a/docs/api-derive/modules/_types_.md b/docs/api-derive/modules/_types_.md index 2809557a68..bc385531b2 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:8](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/types.ts#L8)* #### Type declaration @@ -19,7 +19,7 @@ ___ **Ƭ DerivedBalancesMap**: *`object`* -*Defined in [types.ts:26](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/types.ts#L26)* +*Defined in [types.ts:26](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/types.ts#L26)* #### Type declaration @@ -32,7 +32,7 @@ ___ **Ƭ DerivedFees**: *`object`* -*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/types.ts#L18)* #### Type declaration @@ -43,7 +43,7 @@ ___ **Ƭ DerivedReferendumVote**: *`object`* -*Defined in [types.ts:30](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api-derive/src/types.ts#L30)* +*Defined in [types.ts:30](https://github.com/polkadot-js/api/blob/6eb859c/packages/api-derive/src/types.ts#L30)* #### Type declaration diff --git a/docs/api-derive/modules/_util_cache_.md b/docs/api-derive/modules/_util_cache_.md index b244d3cc63..f19e349c9a 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/1c6a89b/packages/api-derive/src/util/cache.ts#L23)* +*Defined in [util/cache.ts:23](https://github.com/polkadot-js/api/blob/6eb859c/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 2ad5a7d585..7c4d78bc83 100644 --- a/docs/api/classes/_base_.apibase.md +++ b/docs/api/classes/_base_.apibase.md @@ -27,7 +27,7 @@ ⊕ **new ApiBase**(provider?: *[ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface`*, type: *[ApiType](../modules/_types_.md#apitype)*): [ApiBase](_base_.apibase.md) -*Defined in [Base.ts:72](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L72)* +*Defined in [Base.ts:72](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L72)* *__description__*: Create an instance of the class @@ -62,7 +62,7 @@ ___ getderive(): [Derive](../interfaces/_types_.derive.md)<`CodecResult`, `SubscriptionResult`> -*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L180)* +*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L180)* *__description__*: Derived results that are injected into the API, allowing for combinations of various query results. @@ -83,7 +83,7 @@ ___ getgenesisHash(): `Hash` -*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L123)* +*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L123)* *__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. @@ -96,7 +96,7 @@ ___ gethasSubscriptions(): `boolean` -*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L132)* +*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L132)* *__description__*: `true` when subscriptions are supported @@ -109,7 +109,7 @@ ___ getquery(): [QueryableStorage](../interfaces/_types_.queryablestorage.md)<`CodecResult`, `SubscriptionResult`> -*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L200)* +*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L200)* *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. @@ -132,7 +132,7 @@ ___ getrpc(): [DecoratedRpc](../interfaces/_types_.decoratedrpc.md)<`CodecResult`, `SubscriptionResult`> -*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L220)* +*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L220)* *__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. @@ -155,7 +155,7 @@ ___ getruntimeMetadata(): `Metadata` -*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L139)* +*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L139)* *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. @@ -168,7 +168,7 @@ ___ getruntimeVersion(): `RuntimeVersion` -*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L148)* +*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L148)* *__description__*: Contains the version information for the current runtime. @@ -181,7 +181,7 @@ ___ gettx(): [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md)<`CodecResult`, `SubscriptionResult`> -*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L238)* +*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L238)* *__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. @@ -204,7 +204,7 @@ ___ gettype(): [ApiType](../modules/_types_.md#apitype) -*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L157)* +*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L157)* *__description__*: The type of this API instance, either 'rxjs' or 'promise' @@ -220,7 +220,7 @@ ___ ▸ **disconnect**(): `void` -*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L247)* +*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L247)* *__description__*: Disconnect from the underlying provider, halting all comms @@ -233,7 +233,7 @@ ___ ▸ **on**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` -*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L270)* +*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L270)* *__description__*: Attach an eventemitter handler to listen to a specific event @@ -265,7 +265,7 @@ ___ ▸ **once**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` -*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L295)* +*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L295)* *__description__*: Attach an one-time eventemitter handler to listen to a specific event @@ -297,7 +297,7 @@ ___ ▸ **registerTypes**(types?: *`RegistryTypes`*): `void` -*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L304)* +*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L304)* *__description__*: Register additional user-defined of chain-specific types in the type registry @@ -316,7 +316,7 @@ ___ ▸ **setSigner**(signer: *[Signer](../interfaces/_types_.signer.md)*): `void` -*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L164)* +*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L164)* *__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair diff --git a/docs/api/classes/_promise_combinator_.combinator.md b/docs/api/classes/_promise_combinator_.combinator.md index 5dceae64f7..01b29c7242 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/1c6a89b/packages/api/src/promise/Combinator.ts#L21)* +*Defined in [promise/Combinator.ts:21](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/api/src/promise/Combinator.ts#L67)* +*Defined in [promise/Combinator.ts:67](https://github.com/polkadot-js/api/blob/6eb859c/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 a512784d6f..60c482addb 100644 --- a/docs/api/classes/_promise_index_.apipromise.html +++ b/docs/api/classes/_promise_index_.apipromise.html @@ -2211,7 +2211,7 @@

constructor

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

Overrides ApiBase.constructor

-

Defined in promise/index.ts:128

+

Defined in promise/index.ts:128

description: Creates an instance of the ApiPromise class

example:

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

derive

getderive(): Derive<CodecResult, SubscriptionResult>

Inherited from ApiBase.derive

-

Defined in Base.ts:180

+

Defined in Base.ts:180

description: Derived results that are injected into the API, allowing for combinations of various query results.

example:

api.derive.chain.bestNumber((number) => {
@@ -2260,7 +2260,7 @@
 

genesisHash

getgenesisHash(): Hash

Inherited from ApiBase.genesisHash

-

Defined in Base.ts:123

+

Defined in Base.ts:123

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


@@ -2268,14 +2268,14 @@

hasSubscriptions

gethasSubscriptions(): boolean

Inherited from ApiBase.hasSubscriptions

-

Defined in Base.ts:132

+

Defined in Base.ts:132

description: true when subscriptions are supported

Returns: boolean


isReady

getisReady(): Promise<ApiPromise>

-

Defined in promise/index.ts:163

+

Defined in promise/index.ts:163

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

Returns: Promise<ApiPromise>


@@ -2283,7 +2283,7 @@

query

getquery(): QueryableStorage<CodecResult, SubscriptionResult>

Inherited from ApiBase.query

-

Defined in Base.ts:200

+

Defined in Base.ts:200

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:

@@ -2297,7 +2297,7 @@

rpc

getrpc(): DecoratedRpc<CodecResult, SubscriptionResult>

Inherited from ApiBase.rpc

-

Defined in Base.ts:220

+

Defined in Base.ts:220

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:

@@ -2311,7 +2311,7 @@

runtimeMetadata

getruntimeMetadata(): Metadata

Inherited from ApiBase.runtimeMetadata

-

Defined in Base.ts:139

+

Defined in Base.ts:139

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


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

runtimeVersion

getruntimeVersion(): RuntimeVersion

Inherited from ApiBase.runtimeVersion

-

Defined in Base.ts:148

+

Defined in Base.ts:148

description: Contains the version information for the current runtime.

Returns: RuntimeVersion


@@ -2327,7 +2327,7 @@

tx

gettx(): SubmittableExtrinsics<CodecResult, SubscriptionResult>

Inherited from ApiBase.tx

-

Defined in Base.ts:238

+

Defined in Base.ts:238

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
@@ -2342,7 +2342,7 @@
 

type

gettype(): ApiType

Inherited from ApiBase.type

-

Defined in Base.ts:157

+

Defined in Base.ts:157

description: The type of this API instance, either 'rxjs' or 'promise'

Returns: ApiType


@@ -2350,14 +2350,14 @@

clone

▸ clone(): ApiPromise

-

Defined in promise/index.ts:170

+

Defined in promise/index.ts:170

description: Returns a clone of this ApiPromise instance (new underlying provider connection)

Returns: ApiPromise


combineLatest

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

-

Defined in promise/index.ts:197

+

Defined in promise/index.ts:197

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

example:

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

▸ disconnect(): void

Implementation of ApiPromiseInterface.disconnect

Inherited from ApiBase.disconnect

-

Defined in Base.ts:247

+

Defined in Base.ts:247

description: Disconnect from the underlying provider, halting all comms

Returns: void


@@ -2409,7 +2409,7 @@

on

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

Inherited from ApiBase.on

-

Defined in Base.ts:270

+

Defined in Base.ts:270

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

example:

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

once

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

Inherited from ApiBase.once

-

Defined in Base.ts:295

+

Defined in Base.ts:295

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

example:

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

▸ registerTypes(types?: RegistryTypes): void

Implementation of ApiPromiseInterface.registerTypes

Inherited from ApiBase.registerTypes

-

Defined in Base.ts:304

+

Defined in Base.ts:304

description: Register additional user-defined of chain-specific types in the type registry

Parameters:

@@ -2512,7 +2512,7 @@

▸ setSigner(signer: Signer): void

Implementation of ApiPromiseInterface.setSigner

Inherited from ApiBase.setSigner

-

Defined in Base.ts:164

+

Defined in Base.ts:164

description: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair

Parameters:

@@ -2534,7 +2534,7 @@

<Static> create

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

-

Defined in promise/index.ts:126

+

Defined in promise/index.ts:126

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

example:

import Api from '@polkadot/api/promise';
@@ -2610,7 +2610,7 @@
     
 
diff --git a/docs/api/classes/_promise_index_.apipromise.md b/docs/api/classes/_promise_index_.apipromise.md index eeebf5c31e..f1fd3bf160 100644 --- a/docs/api/classes/_promise_index_.apipromise.md +++ b/docs/api/classes/_promise_index_.apipromise.md @@ -107,7 +107,7 @@ ApiPromise.create().then((api) => { *Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [promise/index.ts:128](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/promise/index.ts#L128)* +*Defined in [promise/index.ts:128](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/promise/index.ts#L128)* *__description__*: Creates an instance of the ApiPromise class @@ -143,7 +143,7 @@ getderive(): [Derive](../interfaces/_types_.derive.md)<[CodecResult](), [Subscri *Inherited from [ApiBase](_base_.apibase.md).[derive](_base_.apibase.md#derive)* -*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L180)* +*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L180)* *__description__*: Derived results that are injected into the API, allowing for combinations of various query results. @@ -166,7 +166,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* -*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L123)* +*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L123)* *__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. @@ -181,7 +181,7 @@ gethasSubscriptions(): `boolean` *Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)* -*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L132)* +*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L132)* *__description__*: `true` when subscriptions are supported @@ -194,7 +194,7 @@ ___ getisReady(): `Promise`<[ApiPromise](_promise_index_.apipromise.md)> -*Defined in [promise/index.ts:163](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/promise/index.ts#L163)* +*Defined in [promise/index.ts:163](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/promise/index.ts#L163)* *__description__*: Promise that returns the first time we are connected and loaded @@ -209,7 +209,7 @@ getquery(): [QueryableStorage](../interfaces/_types_.queryablestorage.md)<[Codec *Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)* -*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L200)* +*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L200)* *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. @@ -234,7 +234,7 @@ getrpc(): [DecoratedRpc](../interfaces/_types_.decoratedrpc.md)<[CodecResult](), *Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)* -*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L220)* +*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L220)* *__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime. @@ -259,7 +259,7 @@ getruntimeMetadata(): `Metadata` *Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)* -*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L139)* +*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L139)* *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. @@ -274,7 +274,7 @@ getruntimeVersion(): `RuntimeVersion` *Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)* -*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L148)* +*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L148)* *__description__*: Contains the version information for the current runtime. @@ -289,7 +289,7 @@ gettx(): [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md) *Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)* -*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L238)* +*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L238)* *__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. @@ -314,7 +314,7 @@ gettype(): [ApiType](../modules/_types_.md#apitype) *Inherited from [ApiBase](_base_.apibase.md).[type](_base_.apibase.md#type)* -*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L157)* +*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L157)* *__description__*: The type of this API instance, either 'rxjs' or 'promise' @@ -330,7 +330,7 @@ ___ ▸ **clone**(): [ApiPromise](_promise_index_.apipromise.md) -*Defined in [promise/index.ts:170](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/promise/index.ts#L170)* +*Defined in [promise/index.ts:170](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/promise/index.ts#L170)* *__description__*: Returns a clone of this ApiPromise instance (new underlying provider connection) @@ -343,7 +343,7 @@ ___ ▸ **combineLatest**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction) \| [[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction), `Array`]>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [SubscriptionResult]() -*Defined in [promise/index.ts:197](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/promise/index.ts#L197)* +*Defined in [promise/index.ts:197](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/promise/index.ts#L197)* *__description__*: Creates a combinator that can be used to combine the latest results from multiple subscriptions @@ -382,7 +382,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[disconnect](_base_.apibase.md#disconnect)* -*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L247)* +*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L247)* *__description__*: Disconnect from the underlying provider, halting all comms @@ -397,7 +397,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)* -*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L270)* +*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L270)* *__description__*: Attach an eventemitter handler to listen to a specific event @@ -431,7 +431,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)* -*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L295)* +*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L295)* *__description__*: Attach an one-time eventemitter handler to listen to a specific event @@ -467,7 +467,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[registerTypes](_base_.apibase.md#registertypes)* -*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L304)* +*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L304)* *__description__*: Register additional user-defined of chain-specific types in the type registry @@ -490,7 +490,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[setSigner](_base_.apibase.md#setsigner)* -*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L164)* +*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L164)* *__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair @@ -509,7 +509,7 @@ ___ ▸ **create**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface`*): `Promise`<[ApiPromise](_promise_index_.apipromise.md)> -*Defined in [promise/index.ts:126](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/promise/index.ts#L126)* +*Defined in [promise/index.ts:126](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/promise/index.ts#L126)* *__description__*: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance. diff --git a/docs/api/classes/_rx_index_.apirx.html b/docs/api/classes/_rx_index_.apirx.html index 90361c45e5..6c17120b0c 100644 --- a/docs/api/classes/_rx_index_.apirx.html +++ b/docs/api/classes/_rx_index_.apirx.html @@ -2225,7 +2225,7 @@

constructor

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

Overrides ApiBase.constructor

-

Defined in rx/index.ts:142

+

Defined in rx/index.ts:142

description: Create an instance of the ApiRx class

example:

import { switchMap } from 'rxjs/operators';
@@ -2263,7 +2263,7 @@
 

derive

getderive(): Derive<RxResult, RxResult>

Inherited from ApiBase.derive

-

Defined in Base.ts:180

+

Defined in Base.ts:180

description: Derived results that are injected into the API, allowing for combinations of various query results.

example:

api.derive.chain.bestNumber((number) => {
@@ -2276,7 +2276,7 @@
 

genesisHash

getgenesisHash(): Hash

Inherited from ApiBase.genesisHash

-

Defined in Base.ts:123

+

Defined in Base.ts:123

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


@@ -2284,21 +2284,21 @@

hasSubscriptions

gethasSubscriptions(): boolean

Inherited from ApiBase.hasSubscriptions

-

Defined in Base.ts:132

+

Defined in Base.ts:132

description: true when subscriptions are supported

Returns: boolean


isConnected

getisConnected(): Observable<boolean>

-

Defined in rx/index.ts:182

+

Defined in rx/index.ts:182

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:189

+

Defined in rx/index.ts:189

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

Returns: Observable<ApiRx>


@@ -2306,7 +2306,7 @@

query

getquery(): QueryableStorage<RxResult, RxResult>

Inherited from ApiBase.query

-

Defined in Base.ts:200

+

Defined in Base.ts:200

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:

@@ -2320,7 +2320,7 @@

rpc

getrpc(): DecoratedRpc<RxResult, RxResult>

Inherited from ApiBase.rpc

-

Defined in Base.ts:220

+

Defined in Base.ts:220

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:

@@ -2334,7 +2334,7 @@

runtimeMetadata

getruntimeMetadata(): Metadata

Inherited from ApiBase.runtimeMetadata

-

Defined in Base.ts:139

+

Defined in Base.ts:139

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


@@ -2342,7 +2342,7 @@

runtimeVersion

getruntimeVersion(): RuntimeVersion

Inherited from ApiBase.runtimeVersion

-

Defined in Base.ts:148

+

Defined in Base.ts:148

description: Contains the version information for the current runtime.

Returns: RuntimeVersion


@@ -2350,7 +2350,7 @@

tx

gettx(): SubmittableExtrinsics<RxResult, RxResult>

Inherited from ApiBase.tx

-

Defined in Base.ts:238

+

Defined in Base.ts:238

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
@@ -2365,7 +2365,7 @@
 

type

gettype(): ApiType

Inherited from ApiBase.type

-

Defined in Base.ts:157

+

Defined in Base.ts:157

description: The type of this API instance, either 'rxjs' or 'promise'

Returns: ApiType


@@ -2373,7 +2373,7 @@

clone

▸ clone(): ApiRx

-

Defined in rx/index.ts:196

+

Defined in rx/index.ts:196

description: Returns a clone of this ApiRx instance (new underlying provider connection)

Returns: ApiRx


@@ -2382,7 +2382,7 @@

▸ disconnect(): void

Implementation of ApiRxInterface.disconnect

Inherited from ApiBase.disconnect

-

Defined in Base.ts:247

+

Defined in Base.ts:247

description: Disconnect from the underlying provider, halting all comms

Returns: void


@@ -2390,7 +2390,7 @@

on

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

Inherited from ApiBase.on

-

Defined in Base.ts:270

+

Defined in Base.ts:270

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

example:

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

once

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

Inherited from ApiBase.once

-

Defined in Base.ts:295

+

Defined in Base.ts:295

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

example:

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

▸ registerTypes(types?: RegistryTypes): void

Implementation of ApiRxInterface.registerTypes

Inherited from ApiBase.registerTypes

-

Defined in Base.ts:304

+

Defined in Base.ts:304

description: Register additional user-defined of chain-specific types in the type registry

Parameters:

@@ -2493,7 +2493,7 @@

▸ setSigner(signer: Signer): void

Implementation of ApiRxInterface.setSigner

Inherited from ApiBase.setSigner

-

Defined in Base.ts:164

+

Defined in Base.ts:164

description: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair

Parameters:

@@ -2515,7 +2515,7 @@

<Static> create

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

-

Defined in rx/index.ts:140

+

Defined in rx/index.ts:140

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

example:

import { switchMap } from 'rxjs/operators';
@@ -2593,7 +2593,7 @@
     
 
diff --git a/docs/api/classes/_rx_index_.apirx.md b/docs/api/classes/_rx_index_.apirx.md index 4a2919423a..faf55823c2 100644 --- a/docs/api/classes/_rx_index_.apirx.md +++ b/docs/api/classes/_rx_index_.apirx.md @@ -121,7 +121,7 @@ api.query.system *Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [rx/index.ts:142](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/rx/index.ts#L142)* +*Defined in [rx/index.ts:142](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/rx/index.ts#L142)* *__description__*: Create an instance of the ApiRx class @@ -161,7 +161,7 @@ getderive(): [Derive](../interfaces/_types_.derive.md)<[RxResult](../modules/_rx *Inherited from [ApiBase](_base_.apibase.md).[derive](_base_.apibase.md#derive)* -*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L180)* +*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L180)* *__description__*: Derived results that are injected into the API, allowing for combinations of various query results. @@ -184,7 +184,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* -*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L123)* +*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L123)* *__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. @@ -199,7 +199,7 @@ gethasSubscriptions(): `boolean` *Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)* -*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L132)* +*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L132)* *__description__*: `true` when subscriptions are supported @@ -212,7 +212,7 @@ ___ getisConnected(): `Observable`<`boolean`> -*Defined in [rx/index.ts:182](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/rx/index.ts#L182)* +*Defined in [rx/index.ts:182](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/rx/index.ts#L182)* *__description__*: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity. @@ -225,7 +225,7 @@ ___ getisReady(): `Observable`<[ApiRx](_rx_index_.apirx.md)> -*Defined in [rx/index.ts:189](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/rx/index.ts#L189)* +*Defined in [rx/index.ts:189](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/rx/index.ts#L189)* *__description__*: Observable that returns the first time we are connected and loaded @@ -240,7 +240,7 @@ getquery(): [QueryableStorage](../interfaces/_types_.queryablestorage.md)<[RxRes *Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)* -*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L200)* +*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L200)* *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. @@ -265,7 +265,7 @@ getrpc(): [DecoratedRpc](../interfaces/_types_.decoratedrpc.md)<[RxResult](../mo *Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)* -*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L220)* +*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L220)* *__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. @@ -290,7 +290,7 @@ getruntimeMetadata(): `Metadata` *Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)* -*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L139)* +*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L139)* *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. @@ -305,7 +305,7 @@ getruntimeVersion(): `RuntimeVersion` *Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)* -*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L148)* +*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L148)* *__description__*: Contains the version information for the current runtime. @@ -320,7 +320,7 @@ gettx(): [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md) *Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)* -*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L238)* +*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L238)* *__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. @@ -345,7 +345,7 @@ gettype(): [ApiType](../modules/_types_.md#apitype) *Inherited from [ApiBase](_base_.apibase.md).[type](_base_.apibase.md#type)* -*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L157)* +*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L157)* *__description__*: The type of this API instance, either 'rxjs' or 'promise' @@ -361,7 +361,7 @@ ___ ▸ **clone**(): [ApiRx](_rx_index_.apirx.md) -*Defined in [rx/index.ts:196](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/rx/index.ts#L196)* +*Defined in [rx/index.ts:196](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/rx/index.ts#L196)* *__description__*: Returns a clone of this ApiRx instance (new underlying provider connection) @@ -378,7 +378,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[disconnect](_base_.apibase.md#disconnect)* -*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L247)* +*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L247)* *__description__*: Disconnect from the underlying provider, halting all comms @@ -393,7 +393,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)* -*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L270)* +*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L270)* *__description__*: Attach an eventemitter handler to listen to a specific event @@ -427,7 +427,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)* -*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L295)* +*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L295)* *__description__*: Attach an one-time eventemitter handler to listen to a specific event @@ -463,7 +463,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[registerTypes](_base_.apibase.md#registertypes)* -*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L304)* +*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L304)* *__description__*: Register additional user-defined of chain-specific types in the type registry @@ -486,7 +486,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[setSigner](_base_.apibase.md#setsigner)* -*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L164)* +*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L164)* *__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair @@ -505,7 +505,7 @@ ___ ▸ **create**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface`*): `Observable`<[ApiRx](_rx_index_.apirx.md)> -*Defined in [rx/index.ts:140](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/rx/index.ts#L140)* +*Defined in [rx/index.ts:140](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/rx/index.ts#L140)* *__description__*: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance. diff --git a/docs/api/classes/_submittableextrinsic_.submittableextrinsic.md b/docs/api/classes/_submittableextrinsic_.submittableextrinsic.md index bb66bab06a..2a4bf27920 100644 --- a/docs/api/classes/_submittableextrinsic_.submittableextrinsic.md +++ b/docs/api/classes/_submittableextrinsic_.submittableextrinsic.md @@ -27,7 +27,7 @@ *Overrides Extrinsic.__constructor* -*Defined in [SubmittableExtrinsic.ts:62](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/SubmittableExtrinsic.ts#L62)* +*Defined in [SubmittableExtrinsic.ts:62](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/SubmittableExtrinsic.ts#L62)* **Parameters:** @@ -77,7 +77,7 @@ getType(): `E` *Inherited from Struct.Type* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -92,7 +92,7 @@ getargs(): `Array`<`Codec`> *Inherited from Extrinsic.args* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L76)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L76)* *__description__*: The arguments passed to for the call, exposes args so it is compatible with \[\[Method\]\] @@ -107,7 +107,7 @@ getcallIndex(): `Uint8Array` *Inherited from Extrinsic.callIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L83)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L83)* *__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method @@ -122,7 +122,7 @@ getdata(): `Uint8Array` *Inherited from Extrinsic.data* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L90)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L90)* *__description__*: The actual data for the Method @@ -139,7 +139,7 @@ getencodedLength(): `number` *Overrides Struct.encodedLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L97)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L97)* *__description__*: The length of the value when encoded as a Uint8Array @@ -154,7 +154,7 @@ gethash(): `Hash` *Inherited from Extrinsic.hash* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L106)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L106)* *__description__*: Convernience function, encodes the extrinsic and returns the actual hash @@ -169,7 +169,7 @@ getisEmpty(): `boolean` *Inherited from Struct.isEmpty* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -184,7 +184,7 @@ getisSigned(): `boolean` *Inherited from Extrinsic.isSigned* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L115)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L115)* *__description__*: `true` id the extrinsic is signed @@ -199,7 +199,7 @@ getlength(): `number` *Inherited from Extrinsic.length* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L122)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L122)* *__description__*: The length of the encoded value @@ -214,7 +214,7 @@ getmeta(): `FunctionMetadata` *Inherited from Extrinsic.meta* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L129)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L129)* *__description__*: The \[\[FunctionMetadata\]\] that describes the extrinsic @@ -229,7 +229,7 @@ getmethod(): `Method` *Inherited from Extrinsic.method* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L136)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L136)* *__description__*: The \[\[Method\]\] this extrinsic wraps @@ -244,7 +244,7 @@ getsignature(): `ExtrinsicSignature` *Inherited from Extrinsic.signature* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L143)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L143)* *__description__*: The \[\[ExtrinsicSignature\]\] @@ -277,7 +277,7 @@ ___ *Inherited from Extrinsic.addSignature* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:150](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L150)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:150](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L150)* *__description__*: Add an \[\[ExtrinsicSignature\]\] to the extrinsic (already generated) @@ -348,7 +348,7 @@ ___ *Inherited from Struct.eq* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -391,7 +391,7 @@ ___ *Overrides Map.get* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -412,7 +412,7 @@ ___ *Inherited from Struct.getAtIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -467,11 +467,11 @@ ___ ▸ **send**(statusCb: *`function`*): `SumbitableResultSubscription`<`CodecResult`, `SubscriptionResult`> -*Defined in [SubmittableExtrinsic.ts:135](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/SubmittableExtrinsic.ts#L135)* +*Defined in [SubmittableExtrinsic.ts:135](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/SubmittableExtrinsic.ts#L135)* **Returns:** `SumbitableResultResult`<`CodecResult`, `SubscriptionResult`> -*Defined in [SubmittableExtrinsic.ts:136](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/SubmittableExtrinsic.ts#L136)* +*Defined in [SubmittableExtrinsic.ts:136](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/SubmittableExtrinsic.ts#L136)* **Parameters:** @@ -510,7 +510,7 @@ ___ *Overrides Extrinsic.sign* -*Defined in [SubmittableExtrinsic.ts:153](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/SubmittableExtrinsic.ts#L153)* +*Defined in [SubmittableExtrinsic.ts:153](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/SubmittableExtrinsic.ts#L153)* **Parameters:** @@ -530,7 +530,7 @@ ___ ▸ **signAndSend**(account: *`KeyringPair` \| `string` \| `AccountId` \| `Address`*, statusCb: *`StatusCb`*): `SumbitableResultSubscription`<`CodecResult`, `SubscriptionResult`> -*Defined in [SubmittableExtrinsic.ts:165](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/SubmittableExtrinsic.ts#L165)* +*Defined in [SubmittableExtrinsic.ts:165](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/SubmittableExtrinsic.ts#L165)* **Parameters:** @@ -541,7 +541,7 @@ ___ **Returns:** `SumbitableResultResult`<`CodecResult`, `SubscriptionResult`> -*Defined in [SubmittableExtrinsic.ts:166](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/SubmittableExtrinsic.ts#L166)* +*Defined in [SubmittableExtrinsic.ts:166](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/SubmittableExtrinsic.ts#L166)* **Parameters:** @@ -561,7 +561,7 @@ ___ *Inherited from Struct.toArray* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -578,7 +578,7 @@ ___ *Overrides Struct.toHex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L168)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L168)* *__description__*: Returns a hex string representation of the value @@ -595,7 +595,7 @@ ___ *Overrides Struct.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:175](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L175)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:175](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L175)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -610,7 +610,7 @@ ___ *Inherited from Struct.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -627,7 +627,7 @@ ___ *Overrides Struct.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:183](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L183)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:183](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L183)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -663,7 +663,7 @@ ___ *Inherited from Extrinsic.decodeExtrinsic* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L44)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L44)* **Parameters:** @@ -682,7 +682,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/api/classes/_submittableextrinsic_.submittableresult.md b/docs/api/classes/_submittableextrinsic_.submittableresult.md index 726345fe5f..41a01e277b 100644 --- a/docs/api/classes/_submittableextrinsic_.submittableresult.md +++ b/docs/api/classes/_submittableextrinsic_.submittableresult.md @@ -25,7 +25,7 @@ *Overrides Struct.__constructor* -*Defined in [SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/SubmittableExtrinsic.ts#L28)* +*Defined in [SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/SubmittableExtrinsic.ts#L28)* **Parameters:** @@ -72,7 +72,7 @@ getType(): `E` *Inherited from Struct.Type* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -87,7 +87,7 @@ getencodedLength(): `number` *Inherited from Struct.encodedLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -100,7 +100,7 @@ ___ getevents(): `Array`<`EventRecord`> -*Defined in [SubmittableExtrinsic.ts:40](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/SubmittableExtrinsic.ts#L40)* +*Defined in [SubmittableExtrinsic.ts:40](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/SubmittableExtrinsic.ts#L40)* *__description__*: the contained events @@ -115,7 +115,7 @@ getisEmpty(): `boolean` *Inherited from Struct.isEmpty* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -128,7 +128,7 @@ ___ getstatus(): `ExtrinsicStatus` -*Defined in [SubmittableExtrinsic.ts:47](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/SubmittableExtrinsic.ts#L47)* +*Defined in [SubmittableExtrinsic.ts:47](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/SubmittableExtrinsic.ts#L47)* *__description__*: the status @@ -141,7 +141,7 @@ ___ gettype(): `string` -*Defined in [SubmittableExtrinsic.ts:54](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/SubmittableExtrinsic.ts#L54)* +*Defined in [SubmittableExtrinsic.ts:54](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/SubmittableExtrinsic.ts#L54)* *__description__*: the type @@ -221,7 +221,7 @@ ___ *Inherited from Struct.eq* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -264,7 +264,7 @@ ___ *Overrides Map.get* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -285,7 +285,7 @@ ___ *Inherited from Struct.getAtIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -360,7 +360,7 @@ ___ *Inherited from Struct.toArray* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -375,7 +375,7 @@ ___ *Inherited from Struct.toHex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -390,7 +390,7 @@ ___ *Inherited from Struct.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -405,7 +405,7 @@ ___ *Inherited from Struct.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -420,7 +420,7 @@ ___ *Inherited from Struct.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -456,7 +456,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/api/index.html b/docs/api/index.html index c1012d918d..ab81c0d3fd 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -2256,7 +2256,7 @@
diff --git a/docs/api/interfaces/_promise_types_.apipromiseinterface.md b/docs/api/interfaces/_promise_types_.apipromiseinterface.md index 6c9fce2073..64c2e681fa 100644 --- a/docs/api/interfaces/_promise_types_.apipromiseinterface.md +++ b/docs/api/interfaces/_promise_types_.apipromiseinterface.md @@ -24,7 +24,7 @@ *Inherited from [ApiBase](../classes/_base_.apibase.md).[constructor](../classes/_base_.apibase.md#constructor)* -*Defined in [Base.ts:72](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L72)* +*Defined in [Base.ts:72](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L72)* *__description__*: Create an instance of the class @@ -59,7 +59,7 @@ ___ **● isReady**: *`Promise`<[ApiPromiseInterface](_promise_types_.apipromiseinterface.md)>* -*Defined in [promise/types.ts:16](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/promise/types.ts#L16)* +*Defined in [promise/types.ts:16](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/promise/types.ts#L16)* ___ @@ -73,7 +73,7 @@ getderive(): [Derive](_types_.derive.md)<[CodecResult](../modules/_promise_types *Inherited from [ApiBase](../classes/_base_.apibase.md).[derive](../classes/_base_.apibase.md#derive)* -*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L180)* +*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L180)* *__description__*: Derived results that are injected into the API, allowing for combinations of various query results. @@ -96,7 +96,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](../classes/_base_.apibase.md).[genesisHash](../classes/_base_.apibase.md#genesishash)* -*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L123)* +*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L123)* *__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. @@ -111,7 +111,7 @@ gethasSubscriptions(): `boolean` *Inherited from [ApiBase](../classes/_base_.apibase.md).[hasSubscriptions](../classes/_base_.apibase.md#hassubscriptions)* -*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L132)* +*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L132)* *__description__*: `true` when subscriptions are supported @@ -126,7 +126,7 @@ getquery(): [QueryableStorage](_types_.queryablestorage.md)<[CodecResult](../mod *Inherited from [ApiBase](../classes/_base_.apibase.md).[query](../classes/_base_.apibase.md#query)* -*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L200)* +*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L200)* *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. @@ -151,7 +151,7 @@ getrpc(): [DecoratedRpc](_types_.decoratedrpc.md)<[CodecResult](../modules/_prom *Inherited from [ApiBase](../classes/_base_.apibase.md).[rpc](../classes/_base_.apibase.md#rpc)* -*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L220)* +*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L220)* *__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. @@ -176,7 +176,7 @@ getruntimeMetadata(): `Metadata` *Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeMetadata](../classes/_base_.apibase.md#runtimemetadata)* -*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L139)* +*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L139)* *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. @@ -191,7 +191,7 @@ getruntimeVersion(): `RuntimeVersion` *Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeVersion](../classes/_base_.apibase.md#runtimeversion)* -*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L148)* +*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L148)* *__description__*: Contains the version information for the current runtime. @@ -206,7 +206,7 @@ gettx(): [SubmittableExtrinsics](_types_.submittableextrinsics.md)<[CodecResult] *Inherited from [ApiBase](../classes/_base_.apibase.md).[tx](../classes/_base_.apibase.md#tx)* -*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L238)* +*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L238)* *__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. @@ -231,7 +231,7 @@ gettype(): [ApiType](../modules/_types_.md#apitype) *Inherited from [ApiBase](../classes/_base_.apibase.md).[type](../classes/_base_.apibase.md#type)* -*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L157)* +*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L157)* *__description__*: The type of this API instance, either 'rxjs' or 'promise' @@ -249,7 +249,7 @@ ___ *Inherited from [ApiBase](../classes/_base_.apibase.md).[disconnect](../classes/_base_.apibase.md#disconnect)* -*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L247)* +*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L247)* *__description__*: Disconnect from the underlying provider, halting all comms @@ -264,7 +264,7 @@ ___ *Inherited from [ApiBase](../classes/_base_.apibase.md).[on](../classes/_base_.apibase.md#on)* -*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L270)* +*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L270)* *__description__*: Attach an eventemitter handler to listen to a specific event @@ -298,7 +298,7 @@ ___ *Inherited from [ApiBase](../classes/_base_.apibase.md).[once](../classes/_base_.apibase.md#once)* -*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L295)* +*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L295)* *__description__*: Attach an one-time eventemitter handler to listen to a specific event @@ -332,7 +332,7 @@ ___ *Inherited from [ApiBase](../classes/_base_.apibase.md).[registerTypes](../classes/_base_.apibase.md#registertypes)* -*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L304)* +*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L304)* *__description__*: Register additional user-defined of chain-specific types in the type registry @@ -353,7 +353,7 @@ ___ *Inherited from [ApiBase](../classes/_base_.apibase.md).[setSigner](../classes/_base_.apibase.md#setsigner)* -*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L164)* +*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L164)* *__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair diff --git a/docs/api/interfaces/_rx_types_.apirxinterface.md b/docs/api/interfaces/_rx_types_.apirxinterface.md index 72a6c33b51..772b4588bc 100644 --- a/docs/api/interfaces/_rx_types_.apirxinterface.md +++ b/docs/api/interfaces/_rx_types_.apirxinterface.md @@ -24,7 +24,7 @@ *Inherited from [ApiBase](../classes/_base_.apibase.md).[constructor](../classes/_base_.apibase.md#constructor)* -*Defined in [Base.ts:72](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L72)* +*Defined in [Base.ts:72](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L72)* *__description__*: Create an instance of the class @@ -59,7 +59,7 @@ ___ **● isConnected**: *`Observable`<`boolean`>* -*Defined in [rx/types.ts:13](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/rx/types.ts#L13)* +*Defined in [rx/types.ts:13](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/rx/types.ts#L13)* ___ @@ -68,7 +68,7 @@ ___ **● isReady**: *`Observable`<[ApiRxInterface](_rx_types_.apirxinterface.md)>* -*Defined in [rx/types.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/rx/types.ts#L14)* +*Defined in [rx/types.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/rx/types.ts#L14)* ___ @@ -82,7 +82,7 @@ getderive(): [Derive](_types_.derive.md)<[RxResult](../modules/_rx_types_.md#rxr *Inherited from [ApiBase](../classes/_base_.apibase.md).[derive](../classes/_base_.apibase.md#derive)* -*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L180)* +*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L180)* *__description__*: Derived results that are injected into the API, allowing for combinations of various query results. @@ -105,7 +105,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](../classes/_base_.apibase.md).[genesisHash](../classes/_base_.apibase.md#genesishash)* -*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L123)* +*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L123)* *__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. @@ -120,7 +120,7 @@ gethasSubscriptions(): `boolean` *Inherited from [ApiBase](../classes/_base_.apibase.md).[hasSubscriptions](../classes/_base_.apibase.md#hassubscriptions)* -*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L132)* +*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L132)* *__description__*: `true` when subscriptions are supported @@ -135,7 +135,7 @@ getquery(): [QueryableStorage](_types_.queryablestorage.md)<[RxResult](../module *Inherited from [ApiBase](../classes/_base_.apibase.md).[query](../classes/_base_.apibase.md#query)* -*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L200)* +*Defined in [Base.ts:200](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L200)* *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. @@ -160,7 +160,7 @@ getrpc(): [DecoratedRpc](_types_.decoratedrpc.md)<[RxResult](../modules/_rx_type *Inherited from [ApiBase](../classes/_base_.apibase.md).[rpc](../classes/_base_.apibase.md#rpc)* -*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L220)* +*Defined in [Base.ts:220](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L220)* *__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. @@ -185,7 +185,7 @@ getruntimeMetadata(): `Metadata` *Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeMetadata](../classes/_base_.apibase.md#runtimemetadata)* -*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L139)* +*Defined in [Base.ts:139](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L139)* *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. @@ -200,7 +200,7 @@ getruntimeVersion(): `RuntimeVersion` *Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeVersion](../classes/_base_.apibase.md#runtimeversion)* -*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L148)* +*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L148)* *__description__*: Contains the version information for the current runtime. @@ -215,7 +215,7 @@ gettx(): [SubmittableExtrinsics](_types_.submittableextrinsics.md)<[RxResult](.. *Inherited from [ApiBase](../classes/_base_.apibase.md).[tx](../classes/_base_.apibase.md#tx)* -*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L238)* +*Defined in [Base.ts:238](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L238)* *__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. @@ -240,7 +240,7 @@ gettype(): [ApiType](../modules/_types_.md#apitype) *Inherited from [ApiBase](../classes/_base_.apibase.md).[type](../classes/_base_.apibase.md#type)* -*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L157)* +*Defined in [Base.ts:157](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L157)* *__description__*: The type of this API instance, either 'rxjs' or 'promise' @@ -258,7 +258,7 @@ ___ *Inherited from [ApiBase](../classes/_base_.apibase.md).[disconnect](../classes/_base_.apibase.md#disconnect)* -*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L247)* +*Defined in [Base.ts:247](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L247)* *__description__*: Disconnect from the underlying provider, halting all comms @@ -273,7 +273,7 @@ ___ *Inherited from [ApiBase](../classes/_base_.apibase.md).[on](../classes/_base_.apibase.md#on)* -*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L270)* +*Defined in [Base.ts:270](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L270)* *__description__*: Attach an eventemitter handler to listen to a specific event @@ -307,7 +307,7 @@ ___ *Inherited from [ApiBase](../classes/_base_.apibase.md).[once](../classes/_base_.apibase.md#once)* -*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L295)* +*Defined in [Base.ts:295](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L295)* *__description__*: Attach an one-time eventemitter handler to listen to a specific event @@ -341,7 +341,7 @@ ___ *Inherited from [ApiBase](../classes/_base_.apibase.md).[registerTypes](../classes/_base_.apibase.md#registertypes)* -*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L304)* +*Defined in [Base.ts:304](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L304)* *__description__*: Register additional user-defined of chain-specific types in the type registry @@ -362,7 +362,7 @@ ___ *Inherited from [ApiBase](../classes/_base_.apibase.md).[setSigner](../classes/_base_.apibase.md#setsigner)* -*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/Base.ts#L164)* +*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/Base.ts#L164)* *__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair diff --git a/docs/api/interfaces/_types_.apibaseinterface.md b/docs/api/interfaces/_types_.apibaseinterface.md index 392625c1b4..c115150efd 100644 --- a/docs/api/interfaces/_types_.apibaseinterface.md +++ b/docs/api/interfaces/_types_.apibaseinterface.md @@ -25,7 +25,7 @@ **● on**: *`function`* -*Defined in [types.ts:158](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L158)* +*Defined in [types.ts:158](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L158)* #### Type declaration ▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` @@ -46,7 +46,7 @@ ___ **● once**: *`function`* -*Defined in [types.ts:159](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L159)* +*Defined in [types.ts:159](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L159)* #### Type declaration ▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` @@ -67,7 +67,7 @@ ___ **● type**: *[ApiType](../modules/_types_.md#apitype)* -*Defined in [types.ts:156](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L156)* +*Defined in [types.ts:156](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L156)* ___ diff --git a/docs/api/interfaces/_types_.apiinterface_decorated.md b/docs/api/interfaces/_types_.apiinterface_decorated.md index 8539955eb9..87b0b5b6d5 100644 --- a/docs/api/interfaces/_types_.apiinterface_decorated.md +++ b/docs/api/interfaces/_types_.apiinterface_decorated.md @@ -15,7 +15,7 @@ **● derive**: *[Derive](_types_.derive.md)<`CodecResult`, `SubscriptionResult`>* -*Defined in [types.ts:142](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L142)* +*Defined in [types.ts:142](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L142)* ___ @@ -24,7 +24,7 @@ ___ **● genesisHash**: *`Hash`* -*Defined in [types.ts:138](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L138)* +*Defined in [types.ts:138](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L138)* ___ @@ -33,7 +33,7 @@ ___ **● hasSubscriptions**: *`boolean`* -*Defined in [types.ts:139](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L139)* +*Defined in [types.ts:139](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L139)* ___ @@ -42,7 +42,7 @@ ___ **● query**: *[QueryableStorage](_types_.queryablestorage.md)<`CodecResult`, `SubscriptionResult`>* -*Defined in [types.ts:143](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L143)* +*Defined in [types.ts:143](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L143)* ___ @@ -51,7 +51,7 @@ ___ **● rpc**: *[DecoratedRpc](_types_.decoratedrpc.md)<`CodecResult`, `SubscriptionResult`>* -*Defined in [types.ts:144](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L144)* +*Defined in [types.ts:144](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L144)* ___ @@ -60,7 +60,7 @@ ___ **● runtimeMetadata**: *`Metadata`* -*Defined in [types.ts:140](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L140)* +*Defined in [types.ts:140](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L140)* ___ @@ -69,7 +69,7 @@ ___ **● runtimeVersion**: *`RuntimeVersion`* -*Defined in [types.ts:141](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L141)* +*Defined in [types.ts:141](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L141)* ___ @@ -78,7 +78,7 @@ ___ **● signer**: *[Signer](_types_.signer.md)* -*Defined in [types.ts:146](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L146)* +*Defined in [types.ts:146](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L146)* ___ @@ -87,7 +87,7 @@ ___ **● tx**: *[SubmittableExtrinsics](_types_.submittableextrinsics.md)<`CodecResult`, `SubscriptionResult`>* -*Defined in [types.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L145)* +*Defined in [types.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L145)* ___ diff --git a/docs/api/interfaces/_types_.apioptions.md b/docs/api/interfaces/_types_.apioptions.md index e9d6150926..37497aa3ce 100644 --- a/docs/api/interfaces/_types_.apioptions.md +++ b/docs/api/interfaces/_types_.apioptions.md @@ -12,7 +12,7 @@ **● derives**: *`DeriveCustom`* -*Defined in [types.ts:116](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L116)* +*Defined in [types.ts:116](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L116)* *__description__*: Add custom derives to be injected @@ -23,7 +23,7 @@ ___ **● provider**: *`ProviderInterface`* -*Defined in [types.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L121)* +*Defined in [types.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L121)* *__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` @@ -34,7 +34,7 @@ ___ **● signer**: *[Signer](_types_.signer.md)* -*Defined in [types.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L125)* +*Defined in [types.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L125)* *__description__*: An external signer which will be used to sign extrinsic when account passed in is not KeyringPair @@ -45,7 +45,7 @@ ___ **● source**: *[ApiBase](../classes/_base_.apibase.md)<`any`, `any`>* -*Defined in [types.ts:129](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L129)* +*Defined in [types.ts:129](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L129)* *__description__*: The source object to use for runtime information (only used when cloning) @@ -56,7 +56,7 @@ ___ **● types**: *`RegistryTypes`* -*Defined in [types.ts:134](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L134)* +*Defined in [types.ts:134](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L134)* *__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/interfaces/_types_.decoratedrpc.md b/docs/api/interfaces/_types_.decoratedrpc.md index 284854bce1..42e4bbcbba 100644 --- a/docs/api/interfaces/_types_.decoratedrpc.md +++ b/docs/api/interfaces/_types_.decoratedrpc.md @@ -15,7 +15,7 @@ **● author**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>* -*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L34)* +*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L34)* ___ @@ -24,7 +24,7 @@ ___ **● chain**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>* -*Defined in [types.ts:35](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L35)* +*Defined in [types.ts:35](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L35)* ___ @@ -33,7 +33,7 @@ ___ **● state**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>* -*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L36)* +*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L36)* ___ @@ -42,7 +42,7 @@ ___ **● system**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>* -*Defined in [types.ts:37](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L37)* +*Defined in [types.ts:37](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L37)* ___ diff --git a/docs/api/interfaces/_types_.decoratedrpc_method.md b/docs/api/interfaces/_types_.decoratedrpc_method.md index 56243cc009..23e4c988b9 100644 --- a/docs/api/interfaces/_types_.decoratedrpc_method.md +++ b/docs/api/interfaces/_types_.decoratedrpc_method.md @@ -14,7 +14,7 @@ ▸ **__call**(arg1?: *`CodecArg`*, arg2?: *`CodecArg`*, arg3?: *`CodecArg`*): `CodecResult` -*Defined in [types.ts:23](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L23)* +*Defined in [types.ts:23](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L23)* **Parameters:** @@ -24,7 +24,7 @@ **Returns:** `SubscriptionResult` -*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L24)* **Parameters:** @@ -35,7 +35,7 @@ **Returns:** `SubscriptionResult` -*Defined in [types.ts:25](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L25)* +*Defined in [types.ts:25](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L25)* **Parameters:** diff --git a/docs/api/interfaces/_types_.derivemethodbase.md b/docs/api/interfaces/_types_.derivemethodbase.md index 234ec8d634..cc05d0a1bf 100644 --- a/docs/api/interfaces/_types_.derivemethodbase.md +++ b/docs/api/interfaces/_types_.derivemethodbase.md @@ -10,7 +10,7 @@ # Callable ▸ **__call**(...params: *`Array`<`CodecArg`>*): `CodecResult` -*Defined in [types.ts:88](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L88)* +*Defined in [types.ts:88](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L88)* **Parameters:** diff --git a/docs/api/interfaces/_types_.queryablestoragefunctionbase.md b/docs/api/interfaces/_types_.queryablestoragefunctionbase.md index fa685cc948..606ea570d6 100644 --- a/docs/api/interfaces/_types_.queryablestoragefunctionbase.md +++ b/docs/api/interfaces/_types_.queryablestoragefunctionbase.md @@ -14,7 +14,7 @@ ▸ **__call**(arg?: *`any`*): `Uint8Array` -*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L50)* +*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L50)* **Parameters:** @@ -24,7 +24,7 @@ **Returns:** `CodecResult` -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/StorageKey.ts#L12)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/StorageKey.ts#L12)* **Parameters:** @@ -42,7 +42,7 @@ **● at**: *`function`* -*Defined in [types.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L52)* +*Defined in [types.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L52)* #### Type declaration ▸(hash: *`Hash` \| `Uint8Array` \| `string`*, arg?: *`CodecArg`*): `CodecResult` @@ -63,7 +63,7 @@ ___ **● hash**: *`function`* -*Defined in [types.ts:53](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L53)* +*Defined in [types.ts:53](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L53)* #### Type declaration ▸(arg?: *`CodecArg`*): [HashResult](../modules/_types_.md#hashresult)<`CodecResult`, `SubscriptionResult`> @@ -83,7 +83,7 @@ ___ **● key**: *`function`* -*Defined in [types.ts:54](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L54)* +*Defined in [types.ts:54](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L54)* #### Type declaration ▸(arg?: *`CodecArg`*): `string` @@ -105,7 +105,7 @@ ___ *Inherited from StorageFunction.meta* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/StorageKey.ts#L14)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/StorageKey.ts#L14)* ___ @@ -116,7 +116,7 @@ ___ *Inherited from StorageFunction.method* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/StorageKey.ts#L15)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/StorageKey.ts#L15)* ___ @@ -127,7 +127,7 @@ ___ *Inherited from StorageFunction.section* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/StorageKey.ts#L16)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/StorageKey.ts#L16)* ___ @@ -136,7 +136,7 @@ ___ **● size**: *`function`* -*Defined in [types.ts:55](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L55)* +*Defined in [types.ts:55](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L55)* #### Type declaration ▸(arg?: *`CodecArg`*): [U64Result](../modules/_types_.md#u64result)<`CodecResult`, `SubscriptionResult`> @@ -158,7 +158,7 @@ ___ *Inherited from StorageFunction.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/StorageKey.ts#L17)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/StorageKey.ts#L17)* #### Type declaration ▸(): `any` diff --git a/docs/api/interfaces/_types_.signer.md b/docs/api/interfaces/_types_.signer.md index 4fbf607e4d..73796b41b2 100644 --- a/docs/api/interfaces/_types_.signer.md +++ b/docs/api/interfaces/_types_.signer.md @@ -12,7 +12,7 @@ **● update**: *`undefined` \| `function`* -*Defined in [types.ts:171](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L171)* +*Defined in [types.ts:171](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L171)* *__description__*: Receives an update for the extrinsic signed by a `signer.sign` @@ -26,7 +26,7 @@ ___ ▸ **sign**(extrinsic: *`Extrinsic`*, address: *`string`*, options: *`SignatureOptions`*): `Promise`<`number`> -*Defined in [types.ts:166](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L166)* +*Defined in [types.ts:166](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L166)* *__description__*: Signs an extrinsic, returning an id (>0) that can be used to retrieve updates diff --git a/docs/api/interfaces/_types_.submittableextrinsicfunction.md b/docs/api/interfaces/_types_.submittableextrinsicfunction.md index 8f41204913..8d0f280e78 100644 --- a/docs/api/interfaces/_types_.submittableextrinsicfunction.md +++ b/docs/api/interfaces/_types_.submittableextrinsicfunction.md @@ -14,7 +14,7 @@ ▸ **__call**(...args: *`any`[]*): `Method` -*Defined in [types.ts:76](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L76)* +*Defined in [types.ts:76](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L76)* **Parameters:** @@ -24,7 +24,7 @@ **Returns:** [SubmittableExtrinsic](../classes/_submittableextrinsic_.submittableextrinsic.md)<`CodecResult`, `SubscriptionResult`> -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:28](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L28)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:28](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L28)* **Parameters:** @@ -44,7 +44,7 @@ *Inherited from MethodFunction.callIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:30](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L30)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:30](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L30)* ___ @@ -55,7 +55,7 @@ ___ *Inherited from MethodFunction.meta* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:31](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L31)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:31](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L31)* ___ @@ -66,7 +66,7 @@ ___ *Inherited from MethodFunction.method* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:32](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L32)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:32](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L32)* ___ @@ -77,7 +77,7 @@ ___ *Inherited from MethodFunction.section* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:33](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L33)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:33](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L33)* ___ @@ -88,7 +88,7 @@ ___ *Inherited from MethodFunction.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:34](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L34)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:34](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L34)* #### Type declaration ▸(): `any` diff --git a/docs/api/modules/_checktypes_manual_.md b/docs/api/modules/_checktypes_manual_.md index 71914cfb80..527da7a165 100644 --- a/docs/api/modules/_checktypes_manual_.md +++ b/docs/api/modules/_checktypes_manual_.md @@ -8,7 +8,7 @@ ▸ **test**(): `Promise`<`void`> -*Defined in [checkTypes.manual.ts:11](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/checkTypes.manual.ts#L11)* +*Defined in [checkTypes.manual.ts:11](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/checkTypes.manual.ts#L11)* **Returns:** `Promise`<`void`> diff --git a/docs/api/modules/_promise_combinator_.md b/docs/api/modules/_promise_combinator_.md index d4620cbd57..a4fe85569d 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/1c6a89b/packages/api/src/promise/Combinator.ts#L9)* +*Defined in [promise/Combinator.ts:9](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/api/src/promise/Combinator.ts#L10)* +*Defined in [promise/Combinator.ts:10](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/promise/Combinator.ts#L10)* #### Type declaration ▸(cb: *`function`*): [SubscriptionResult]() diff --git a/docs/api/modules/_promise_types_.md b/docs/api/modules/_promise_types_.md index 8e48cc705d..1bddf579ec 100644 --- a/docs/api/modules/_promise_types_.md +++ b/docs/api/modules/_promise_types_.md @@ -24,7 +24,7 @@ **Ƭ CodecResult**: *`Promise`<`Codec`>* -*Defined in [promise/types.ts:13](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/promise/types.ts#L13)* +*Defined in [promise/types.ts:13](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/promise/types.ts#L13)* ___ @@ -33,7 +33,7 @@ ___ **Ƭ QueryableStorageFunction**: *[QueryableStorageFunctionBase](../interfaces/_types_.queryablestoragefunctionbase.md)<[CodecResult](_promise_types_.md#codecresult), [SubscriptionResult](_promise_types_.md#subscriptionresult)>* -*Defined in [promise/types.ts:19](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/promise/types.ts#L19)* +*Defined in [promise/types.ts:19](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/promise/types.ts#L19)* ___ @@ -42,7 +42,7 @@ ___ **Ƭ SubmittableExtrinsic**: *`SubmittableExtrinsicBase`<[CodecResult](_promise_types_.md#codecresult), [SubscriptionResult](_promise_types_.md#subscriptionresult)>* -*Defined in [promise/types.ts:20](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/promise/types.ts#L20)* +*Defined in [promise/types.ts:20](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/promise/types.ts#L20)* ___ @@ -51,7 +51,7 @@ ___ **Ƭ SubmittableExtrinsicFunction**: *`SubmittableExtrinsicFunctionBase`<[CodecResult](_promise_types_.md#codecresult), [SubscriptionResult](_promise_types_.md#subscriptionresult)>* -*Defined in [promise/types.ts:21](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/promise/types.ts#L21)* +*Defined in [promise/types.ts:21](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/promise/types.ts#L21)* ___ @@ -60,7 +60,7 @@ ___ **Ƭ SubscriptionResult**: *`Promise`<`function`>* -*Defined in [promise/types.ts:11](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/promise/types.ts#L11)* +*Defined in [promise/types.ts:11](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/promise/types.ts#L11)* ___ diff --git a/docs/api/modules/_rx_types_.md b/docs/api/modules/_rx_types_.md index f0195f0e2a..1fce072f89 100644 --- a/docs/api/modules/_rx_types_.md +++ b/docs/api/modules/_rx_types_.md @@ -20,7 +20,7 @@ **Ƭ RxResult**: *`Observable`<`Codec`>* -*Defined in [rx/types.ts:10](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/rx/types.ts#L10)* +*Defined in [rx/types.ts:10](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/rx/types.ts#L10)* ___ diff --git a/docs/api/modules/_types_.md b/docs/api/modules/_types_.md index c74e4aa1bd..a3b7124d7e 100644 --- a/docs/api/modules/_types_.md +++ b/docs/api/modules/_types_.md @@ -43,7 +43,7 @@ **Ƭ ApiInterface$Events**: *`RpcRxInterface$Events` \| "ready"* -*Defined in [types.ts:151](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L151)* +*Defined in [types.ts:151](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L151)* ___ @@ -52,7 +52,7 @@ ___ **Ƭ ApiInterface$Rx**: *[ApiInterface$Decorated](../interfaces/_types_.apiinterface_decorated.md)<[RxResult](_rx_types_.md#rxresult), [RxResult](_rx_types_.md#rxresult)>* -*Defined in [types.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L149)* +*Defined in [types.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L149)* ___ @@ -61,7 +61,7 @@ ___ **Ƭ ApiType**: *"promise" \| "rxjs"* -*Defined in [types.ts:153](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L153)* +*Defined in [types.ts:153](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L153)* ___ @@ -70,7 +70,7 @@ ___ **Ƭ DeriveMethod**: *`DeriveMethod<CodecResult, SubscriptionResult>`* -*Defined in [types.ts:99](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L99)* +*Defined in [types.ts:99](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L99)* ___ @@ -79,7 +79,7 @@ ___ **Ƭ HashResult**: *`HashResult<CodecResult, SubscriptionResult>`* -*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L40)* +*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L40)* ___ @@ -88,7 +88,7 @@ ___ **Ƭ OnCallDefinition**: *`function`* -*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L18)* #### Type declaration ▸(method: *[OnCallFunction](_types_.md#oncallfunction)<[RxResult](_rx_types_.md#rxresult), [RxResult](_rx_types_.md#rxresult)>*, params?: *`Array`<`CodecArg`>*, callback?: *`CodecCallback`*, needsCallback?: *`undefined` \| `false` \| `true`*): `CodecResult` \| `SubscriptionResult` @@ -111,7 +111,7 @@ ___ **Ƭ OnCallFunction**: *`function`* -*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L20)* #### Type declaration ▸(...params: *`Array`<`CodecArg`>*): `CodecResult` \| `SubscriptionResult` @@ -131,7 +131,7 @@ ___ **Ƭ QueryableStorageFunction**: *`QueryableStorageFunction<CodecResult, SubscriptionResult>`* -*Defined in [types.ts:63](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L63)* +*Defined in [types.ts:63](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L63)* ___ @@ -140,7 +140,7 @@ ___ **Ƭ U64Result**: *`U64Result<CodecResult, SubscriptionResult>`* -*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/1c6a89b/packages/api/src/types.ts#L45)* +*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/6eb859c/packages/api/src/types.ts#L45)* ___ diff --git a/docs/api/modules/_util_filterevents_.md b/docs/api/modules/_util_filterevents_.md index 340f22d68e..3cf7a74f3c 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/1c6a89b/packages/api/src/util/filterEvents.ts#L9)* +*Defined in [util/filterEvents.ts:9](https://github.com/polkadot-js/api/blob/6eb859c/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 e4adfb2e04..9fe6334b23 100644 --- a/docs/examples/promise/01_simple_connect/index.html +++ b/docs/examples/promise/01_simple_connect/index.html @@ -2204,7 +2204,7 @@ diff --git a/docs/examples/promise/02_listen_to_blocks/index.html b/docs/examples/promise/02_listen_to_blocks/index.html index 7445299624..5ca2d866db 100644 --- a/docs/examples/promise/02_listen_to_blocks/index.html +++ b/docs/examples/promise/02_listen_to_blocks/index.html @@ -2202,7 +2202,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 1f66eb8707..0331795a4c 100644 --- a/docs/examples/promise/03_listen_to_balance_change/index.html +++ b/docs/examples/promise/03_listen_to_balance_change/index.html @@ -2214,7 +2214,7 @@ diff --git a/docs/examples/promise/04_unsubscribe/index.html b/docs/examples/promise/04_unsubscribe/index.html index ee5c74ccbb..d4c2769c5c 100644 --- a/docs/examples/promise/04_unsubscribe/index.html +++ b/docs/examples/promise/04_unsubscribe/index.html @@ -2205,7 +2205,7 @@ diff --git a/docs/examples/promise/05_read_storage/index.html b/docs/examples/promise/05_read_storage/index.html index 0e65aeaed2..54606ef2da 100644 --- a/docs/examples/promise/05_read_storage/index.html +++ b/docs/examples/promise/05_read_storage/index.html @@ -2219,7 +2219,7 @@ diff --git a/docs/examples/promise/06_make_transfer/index.html b/docs/examples/promise/06_make_transfer/index.html index a7327ee5b1..2cddb5ca00 100644 --- a/docs/examples/promise/06_make_transfer/index.html +++ b/docs/examples/promise/06_make_transfer/index.html @@ -2212,7 +2212,7 @@ diff --git a/docs/examples/promise/08_system_events/index.html b/docs/examples/promise/08_system_events/index.html index add2e32d2d..18611e1654 100644 --- a/docs/examples/promise/08_system_events/index.html +++ b/docs/examples/promise/08_system_events/index.html @@ -2215,7 +2215,7 @@ diff --git a/docs/examples/promise/09_transfer_events/index.html b/docs/examples/promise/09_transfer_events/index.html index 03797e0e98..1d46a09799 100644 --- a/docs/examples/promise/09_transfer_events/index.html +++ b/docs/examples/promise/09_transfer_events/index.html @@ -2236,7 +2236,7 @@ diff --git a/docs/examples/promise/10_upgrade_chain/index.html b/docs/examples/promise/10_upgrade_chain/index.html index 791bfe7375..0e85b34170 100644 --- a/docs/examples/promise/10_upgrade_chain/index.html +++ b/docs/examples/promise/10_upgrade_chain/index.html @@ -2238,7 +2238,7 @@ diff --git a/docs/examples/promise/index.html b/docs/examples/promise/index.html index 6ae82f432f..50b4057117 100644 --- a/docs/examples/promise/index.html +++ b/docs/examples/promise/index.html @@ -2193,7 +2193,7 @@ diff --git a/docs/examples/rx/01_simple_connect/index.html b/docs/examples/rx/01_simple_connect/index.html index b004597abd..70b749eb02 100644 --- a/docs/examples/rx/01_simple_connect/index.html +++ b/docs/examples/rx/01_simple_connect/index.html @@ -2207,7 +2207,7 @@ diff --git a/docs/examples/rx/02_listen_to_blocks/index.html b/docs/examples/rx/02_listen_to_blocks/index.html index c63e37802a..3ff4bd4ef0 100644 --- a/docs/examples/rx/02_listen_to_blocks/index.html +++ b/docs/examples/rx/02_listen_to_blocks/index.html @@ -2202,7 +2202,7 @@ diff --git a/docs/examples/rx/03_listen_to_balance_change/index.html b/docs/examples/rx/03_listen_to_balance_change/index.html index b3d273ab45..541bd7931c 100644 --- a/docs/examples/rx/03_listen_to_balance_change/index.html +++ b/docs/examples/rx/03_listen_to_balance_change/index.html @@ -2219,7 +2219,7 @@ diff --git a/docs/examples/rx/04_unsubscribe/index.html b/docs/examples/rx/04_unsubscribe/index.html index 8976f892f7..b6d25d1e6f 100644 --- a/docs/examples/rx/04_unsubscribe/index.html +++ b/docs/examples/rx/04_unsubscribe/index.html @@ -2207,7 +2207,7 @@ diff --git a/docs/examples/rx/05_read_storage/index.html b/docs/examples/rx/05_read_storage/index.html index 2f4aa7a0ad..837f18dd74 100644 --- a/docs/examples/rx/05_read_storage/index.html +++ b/docs/examples/rx/05_read_storage/index.html @@ -2232,7 +2232,7 @@ diff --git a/docs/examples/rx/06_make_transfer/index.html b/docs/examples/rx/06_make_transfer/index.html index 2800a6500f..9474361d27 100644 --- a/docs/examples/rx/06_make_transfer/index.html +++ b/docs/examples/rx/06_make_transfer/index.html @@ -2216,7 +2216,7 @@ diff --git a/docs/examples/rx/08_system_events/index.html b/docs/examples/rx/08_system_events/index.html index 2184be1413..da35ad189c 100644 --- a/docs/examples/rx/08_system_events/index.html +++ b/docs/examples/rx/08_system_events/index.html @@ -2218,7 +2218,7 @@ diff --git a/docs/examples/rx/09_transfer_events/index.html b/docs/examples/rx/09_transfer_events/index.html index 088003b22d..552141d8e8 100644 --- a/docs/examples/rx/09_transfer_events/index.html +++ b/docs/examples/rx/09_transfer_events/index.html @@ -2235,7 +2235,7 @@ diff --git a/docs/examples/rx/10_upgrade_chain/index.html b/docs/examples/rx/10_upgrade_chain/index.html index ac3190a0d8..12d696bd10 100644 --- a/docs/examples/rx/10_upgrade_chain/index.html +++ b/docs/examples/rx/10_upgrade_chain/index.html @@ -2240,7 +2240,7 @@ diff --git a/docs/examples/rx/index.html b/docs/examples/rx/index.html index abf53ee326..92cf97d9ac 100644 --- a/docs/examples/rx/index.html +++ b/docs/examples/rx/index.html @@ -2193,7 +2193,7 @@ diff --git a/docs/index.html b/docs/index.html index 658ce3546a..9e74de32ab 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2186,7 +2186,7 @@ diff --git a/docs/rpc-core/classes/_index_.rpc.md b/docs/rpc-core/classes/_index_.rpc.md index 1194c5b04a..5d6fe56b6c 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:45](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-core/src/index.ts#L45)* +*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-core/src/index.ts#L45)* *__constructor__*: Default constructor for the Api Object @@ -60,7 +60,7 @@ ___ **● _provider**: *`ProviderInterface`* -*Defined in [index.ts:41](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-core/src/index.ts#L41)* +*Defined in [index.ts:41](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-core/src/index.ts#L41)* ___ @@ -71,7 +71,7 @@ ___ *Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[author](../interfaces/_types_.rpcinterface.md#author)* -*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-core/src/index.ts#L42)* +*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-core/src/index.ts#L42)* ___ @@ -82,7 +82,7 @@ ___ *Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[chain](../interfaces/_types_.rpcinterface.md#chain)* -*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-core/src/index.ts#L43)* +*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-core/src/index.ts#L43)* ___ @@ -93,7 +93,7 @@ ___ *Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[state](../interfaces/_types_.rpcinterface.md#state)* -*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-core/src/index.ts#L44)* +*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-core/src/index.ts#L44)* ___ @@ -104,7 +104,7 @@ ___ *Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[system](../interfaces/_types_.rpcinterface.md#system)* -*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-core/src/index.ts#L45)* +*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-core/src/index.ts#L45)* ___ @@ -116,7 +116,7 @@ ___ ▸ **disconnect**(): `void` -*Defined in [index.ts:89](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-core/src/index.ts#L89)* +*Defined in [index.ts:89](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-core/src/index.ts#L89)* *__description__*: Manually disconnect from the attached provider @@ -129,7 +129,7 @@ ___ ▸ **signature**(__namedParameters: *`object`*): `string` -*Defined in [index.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-core/src/index.ts#L78)* +*Defined in [index.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-core/src/index.ts#L78)* *__name__*: signature diff --git a/docs/rpc-core/interfaces/_types_.rpcinterface.md b/docs/rpc-core/interfaces/_types_.rpcinterface.md index 9c4dccb199..8237cd82a0 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/1c6a89b/packages/rpc-core/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/rpc-core/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/rpc-core/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/rpc-core/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/6eb859c/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 05aed1b33a..5cd8cb66a5 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/1c6a89b/packages/rpc-core/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/rpc-core/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/rpc-core/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/6eb859c/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 5e9b4d0d1c..a89311569a 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/1c6a89b/packages/rpc-core/src/types.ts#L12)* +*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/6eb859c/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 074887d5be..eaa0642172 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/1c6a89b/packages/rpc-provider/src/coder/index.ts#L12)* +*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/rpc-provider/src/coder/index.ts#L33)* +*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/rpc-provider/src/coder/index.ts#L39)* +*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/rpc-provider/src/coder/index.ts#L48)* +*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/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 f0c4450974..48f781514e 100644 --- a/docs/rpc-provider/classes/_http_index_.httpprovider.html +++ b/docs/rpc-provider/classes/_http_index_.httpprovider.html @@ -2156,7 +2156,7 @@

constructor

⊕ new HttpProvider(endpoint?: string): HttpProvider

-

Defined in http/index.ts:40

+

Defined in http/index.ts:40

Parameters:

@@ -2182,7 +2182,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


@@ -2191,7 +2191,7 @@

clone

▸ clone(): HttpProvider

Implementation of ProviderInterface.clone

-

Defined in http/index.ts:62

+

Defined in http/index.ts:62

description: Returns a clone of the object

Returns: HttpProvider


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

disconnect

▸ disconnect(): void

Implementation of ProviderInterface.disconnect

-

Defined in http/index.ts:69

+

Defined in http/index.ts:69

description: Manually disconnect from the connection

Returns: void


@@ -2207,7 +2207,7 @@

isConnected

▸ isConnected(): boolean

Implementation of ProviderInterface.isConnected

-

Defined in http/index.ts:77

+

Defined in http/index.ts:77

summary: Whether the node is connected or not.

Returns: boolean true if connected

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

on

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

Implementation of ProviderInterface.on

-

Defined in http/index.ts:85

+

Defined in http/index.ts:85

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

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

Parameters:

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

send

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

Implementation of ProviderInterface.send

-

Defined in http/index.ts:92

+

Defined in http/index.ts:92

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

Parameters:

@@ -2271,7 +2271,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:114

+

Defined in http/index.ts:114

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

Parameters:

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

unsubscribe

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

Implementation of ProviderInterface.unsubscribe

-

Defined in http/index.ts:123

+

Defined in http/index.ts:123

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

Parameters:

@@ -2376,7 +2376,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 7e3833fcf2..374f305926 100644 --- a/docs/rpc-provider/classes/_http_index_.httpprovider.md +++ b/docs/rpc-provider/classes/_http_index_.httpprovider.md @@ -35,7 +35,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/1c6a89b/packages/rpc-provider/src/http/index.ts#L40)* +*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/http/index.ts#L40)* **Parameters:** @@ -55,7 +55,7 @@ ___ gethasSubscriptions(): `boolean` -*Defined in [http/index.ts:55](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/http/index.ts#L55)* +*Defined in [http/index.ts:55](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/http/index.ts#L55)* *__summary__*: `true` when this provider supports subscriptions @@ -73,7 +73,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[clone](../interfaces/_types_.providerinterface.md#clone)* -*Defined in [http/index.ts:62](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/http/index.ts#L62)* +*Defined in [http/index.ts:62](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/http/index.ts#L62)* *__description__*: Returns a clone of the object @@ -88,7 +88,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[disconnect](../interfaces/_types_.providerinterface.md#disconnect)* -*Defined in [http/index.ts:69](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/http/index.ts#L69)* +*Defined in [http/index.ts:69](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/http/index.ts#L69)* *__description__*: Manually disconnect from the connection @@ -103,7 +103,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)* -*Defined in [http/index.ts:77](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/http/index.ts#L77)* +*Defined in [http/index.ts:77](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/http/index.ts#L77)* *__summary__*: Whether the node is connected or not. @@ -119,7 +119,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)* -*Defined in [http/index.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/http/index.ts#L85)* +*Defined in [http/index.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/http/index.ts#L85)* *__summary__*: Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). @@ -143,7 +143,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)* -*Defined in [http/index.ts:92](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/http/index.ts#L92)* +*Defined in [http/index.ts:92](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/http/index.ts#L92)* *__summary__*: Send HTTP POST Request with Body to configured HTTP Endpoint. @@ -165,7 +165,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[subscribe](../interfaces/_types_.providerinterface.md#subscribe)* -*Defined in [http/index.ts:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/http/index.ts#L114)* +*Defined in [http/index.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/http/index.ts#L114)* *__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). @@ -189,7 +189,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)* -*Defined in [http/index.ts:123](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/http/index.ts#L123)* +*Defined in [http/index.ts:123](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/http/index.ts#L123)* *__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 a8e47f2bf5..bb54157a41 100644 --- a/docs/rpc-provider/classes/_mock_index_.mock.md +++ b/docs/rpc-provider/classes/_mock_index_.mock.md @@ -20,7 +20,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/1c6a89b/packages/rpc-provider/src/mock/index.ts#L68)* +*Defined in [mock/index.ts:68](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/mock/index.ts#L68)* **Returns:** [Mock](_mock_index_.mock.md) @@ -34,7 +34,7 @@ ___ **● isUpdating**: *`boolean`* = true -*Defined in [mock/index.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/mock/index.ts#L43)* +*Defined in [mock/index.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/mock/index.ts#L43)* ___ @@ -50,7 +50,7 @@ ___ return subs; }, ({} as MockState$Subscriptions)) -*Defined in [mock/index.ts:57](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/mock/index.ts#L57)* +*Defined in [mock/index.ts:57](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/mock/index.ts#L57)* ___ @@ -62,7 +62,7 @@ ___ gethasSubscriptions(): `boolean` -*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/mock/index.ts#L74)* +*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/mock/index.ts#L74)* **Returns:** `boolean` @@ -78,7 +78,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[clone](../interfaces/_types_.providerinterface.md#clone)* -*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/mock/index.ts#L78)* +*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/mock/index.ts#L78)* **Returns:** [Mock](_mock_index_.mock.md) @@ -91,7 +91,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[disconnect](../interfaces/_types_.providerinterface.md#disconnect)* -*Defined in [mock/index.ts:82](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/mock/index.ts#L82)* +*Defined in [mock/index.ts:82](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/mock/index.ts#L82)* **Returns:** `void` @@ -104,7 +104,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)* -*Defined in [mock/index.ts:86](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/mock/index.ts#L86)* +*Defined in [mock/index.ts:86](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/mock/index.ts#L86)* **Returns:** `boolean` @@ -117,7 +117,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)* -*Defined in [mock/index.ts:90](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/mock/index.ts#L90)* +*Defined in [mock/index.ts:90](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/mock/index.ts#L90)* **Parameters:** @@ -137,7 +137,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)* -*Defined in [mock/index.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/mock/index.ts#L94)* +*Defined in [mock/index.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/mock/index.ts#L94)* **Parameters:** @@ -155,7 +155,7 @@ ___ ▸ **subscribe**(type: *`string`*, method: *`string`*, ...params: *`Array`<`any`>*): `Promise`<`number`> -*Defined in [mock/index.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/mock/index.ts#L102)* +*Defined in [mock/index.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/mock/index.ts#L102)* **Parameters:** @@ -176,7 +176,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)* -*Defined in [mock/index.ts:122](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/mock/index.ts#L122)* +*Defined in [mock/index.ts:122](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/mock/index.ts#L122)* **Parameters:** diff --git a/docs/rpc-provider/classes/_ws_index_.wsprovider.html b/docs/rpc-provider/classes/_ws_index_.wsprovider.html index 633d6ddaf3..ef8bc365f0 100644 --- a/docs/rpc-provider/classes/_ws_index_.wsprovider.html +++ b/docs/rpc-provider/classes/_ws_index_.wsprovider.html @@ -2156,7 +2156,7 @@

constructor

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

-

Defined in ws/index.ts:75

+

Defined in ws/index.ts:75

Parameters:

@@ -2188,7 +2188,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


@@ -2196,14 +2196,14 @@

clone

▸ clone(): WsProvider

-

Defined in ws/index.ts:108

+

Defined in ws/index.ts:108

description: Returns a clone of the object

Returns: WsProvider


connect

▸ connect(): void

-

Defined in ws/index.ts:117

+

Defined in ws/index.ts:117

summary: Manually connect

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

Returns: void

@@ -2211,14 +2211,14 @@

disconnect

▸ disconnect(): void

-

Defined in ws/index.ts:133

+

Defined in ws/index.ts:133

description: Manually disconnect from the connection, clearing autoconnect logic

Returns: void


isConnected

▸ isConnected(): boolean

-

Defined in ws/index.ts:150

+

Defined in ws/index.ts:150

summary: Whether the node is connected or not.

Returns: boolean true if connected

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

on

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

-

Defined in ws/index.ts:159

+

Defined in ws/index.ts:159

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

Parameters:

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

send

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

-

Defined in ws/index.ts:169

+

Defined in ws/index.ts:169

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

Parameters:

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

subscribe

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

-

Defined in ws/index.ts:223

+

Defined in ws/index.ts:223

name: subscribe

summary: Allows subscribing to a specific event.

example:

@@ -2340,7 +2340,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:232

+

Defined in ws/index.ts:232

summary: Allows unsubscribing to subscriptions made with subscribe.

Parameters:

@@ -2410,7 +2410,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 f95e22b829..85bcbfdfb1 100644 --- a/docs/rpc-provider/classes/_ws_index_.wsprovider.md +++ b/docs/rpc-provider/classes/_ws_index_.wsprovider.md @@ -35,7 +35,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/1c6a89b/packages/rpc-provider/src/ws/index.ts#L75)* +*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/ws/index.ts#L75)* **Parameters:** @@ -56,7 +56,7 @@ ___ gethasSubscriptions(): `boolean` -*Defined in [ws/index.ts:101](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/ws/index.ts#L101)* +*Defined in [ws/index.ts:101](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/ws/index.ts#L101)* *__summary__*: `true` when this provider supports subscriptions @@ -72,7 +72,7 @@ ___ ▸ **clone**(): [WsProvider](_ws_index_.wsprovider.md) -*Defined in [ws/index.ts:108](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/ws/index.ts#L108)* +*Defined in [ws/index.ts:108](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/ws/index.ts#L108)* *__description__*: Returns a clone of the object @@ -85,7 +85,7 @@ ___ ▸ **connect**(): `void` -*Defined in [ws/index.ts:117](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/ws/index.ts#L117)* +*Defined in [ws/index.ts:117](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/ws/index.ts#L117)* *__summary__*: Manually connect @@ -100,7 +100,7 @@ ___ ▸ **disconnect**(): `void` -*Defined in [ws/index.ts:133](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/ws/index.ts#L133)* +*Defined in [ws/index.ts:133](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/ws/index.ts#L133)* *__description__*: Manually disconnect from the connection, clearing autoconnect logic @@ -113,7 +113,7 @@ ___ ▸ **isConnected**(): `boolean` -*Defined in [ws/index.ts:150](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/ws/index.ts#L150)* +*Defined in [ws/index.ts:150](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/ws/index.ts#L150)* *__summary__*: Whether the node is connected or not. @@ -127,7 +127,7 @@ ___ ▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void` -*Defined in [ws/index.ts:159](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/ws/index.ts#L159)* +*Defined in [ws/index.ts:159](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/ws/index.ts#L159)* *__summary__*: Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function. @@ -147,7 +147,7 @@ ___ ▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`> -*Defined in [ws/index.ts:169](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/ws/index.ts#L169)* +*Defined in [ws/index.ts:169](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/ws/index.ts#L169)* *__summary__*: Send JSON data using WebSockets to configured HTTP Endpoint or queue. @@ -168,7 +168,7 @@ ___ ▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`> -*Defined in [ws/index.ts:223](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/ws/index.ts#L223)* +*Defined in [ws/index.ts:223](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/ws/index.ts#L223)* *__name__*: subscribe @@ -206,7 +206,7 @@ ___ ▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> -*Defined in [ws/index.ts:232](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/ws/index.ts#L232)* +*Defined in [ws/index.ts:232](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/ws/index.ts#L232)* *__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 f008c23320..2a5200b4e1 100644 --- a/docs/rpc-provider/index.html +++ b/docs/rpc-provider/index.html @@ -2204,7 +2204,7 @@ diff --git a/docs/rpc-provider/interfaces/_types_.providerinterface.md b/docs/rpc-provider/interfaces/_types_.providerinterface.md index 423ccdac12..bfd92a2622 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/1c6a89b/packages/rpc-provider/src/types.ts#L45)* +*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/types.ts#L45)* ___ @@ -29,7 +29,7 @@ ___ ▸ **clone**(): [ProviderInterface](_types_.providerinterface.md) -*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/types.ts#L46)* +*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/types.ts#L46)* **Returns:** [ProviderInterface](_types_.providerinterface.md) @@ -40,7 +40,7 @@ ___ ▸ **disconnect**(): `void` -*Defined in [types.ts:47](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/types.ts#L47)* +*Defined in [types.ts:47](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/types.ts#L47)* **Returns:** `void` @@ -51,7 +51,7 @@ ___ ▸ **isConnected**(): `boolean` -*Defined in [types.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/types.ts#L48)* +*Defined in [types.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/types.ts#L48)* **Returns:** `boolean` @@ -62,7 +62,7 @@ ___ ▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void` -*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/types.ts#L49)* +*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/types.ts#L49)* **Parameters:** @@ -80,7 +80,7 @@ ___ ▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`> -*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/types.ts#L50)* +*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/types.ts#L50)* **Parameters:** @@ -98,7 +98,7 @@ ___ ▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`> -*Defined in [types.ts:51](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/types.ts#L51)* +*Defined in [types.ts:51](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/types.ts#L51)* **Parameters:** @@ -118,7 +118,7 @@ ___ ▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> -*Defined in [types.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-provider/src/types.ts#L52)* +*Defined in [types.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-provider/src/types.ts#L52)* **Parameters:** diff --git a/docs/rpc-provider/modules/_http_types_.md b/docs/rpc-provider/modules/_http_types_.md index ada4f62311..4544cac35d 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/1c6a89b/packages/rpc-provider/src/http/types.ts#L9)* +*Defined in [http/types.ts:9](https://github.com/polkadot-js/api/blob/6eb859c/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 1439096183..f448d667e3 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/1c6a89b/packages/rpc-provider/src/mock/types.ts#L16)* +*Defined in [mock/types.ts:16](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/rpc-provider/src/mock/types.ts#L20)* +*Defined in [mock/types.ts:20](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/rpc-provider/src/mock/types.ts#L5)* +*Defined in [mock/types.ts:5](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/rpc-provider/src/mock/types.ts#L7)* +*Defined in [mock/types.ts:7](https://github.com/polkadot-js/api/blob/6eb859c/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 0033e325b4..b361b29914 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/1c6a89b/packages/rpc-provider/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/rpc-provider/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/rpc-provider/src/types.ts#L36)* +*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/rpc-provider/src/types.ts#L34)* +*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/rpc-provider/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/rpc-provider/src/types.ts#L38)* +*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/rpc-provider/src/types.ts#L42)* +*Defined in [types.ts:42](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/rpc-provider/src/types.ts#L40)* +*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/6eb859c/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 3effd960ef..254784dff5 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:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-rx/src/index.ts#L39)* +*Defined in [index.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-rx/src/index.ts#L39)* **Parameters:** @@ -52,7 +52,7 @@ ___ **● author**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)* -*Defined in [index.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-rx/src/index.ts#L36)* +*Defined in [index.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-rx/src/index.ts#L36)* ___ @@ -61,7 +61,7 @@ ___ **● chain**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)* -*Defined in [index.ts:37](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-rx/src/index.ts#L37)* +*Defined in [index.ts:37](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-rx/src/index.ts#L37)* ___ @@ -70,7 +70,7 @@ ___ **● state**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)* -*Defined in [index.ts:38](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-rx/src/index.ts#L38)* +*Defined in [index.ts:38](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-rx/src/index.ts#L38)* ___ @@ -79,7 +79,7 @@ ___ **● system**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)* -*Defined in [index.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-rx/src/index.ts#L39)* +*Defined in [index.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-rx/src/index.ts#L39)* ___ @@ -91,7 +91,7 @@ ___ ▸ **isConnected**(): `BehaviorSubject`<`boolean`> -*Defined in [index.ts:59](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-rx/src/index.ts#L59)* +*Defined in [index.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-rx/src/index.ts#L59)* **Returns:** `BehaviorSubject`<`boolean`> @@ -102,7 +102,7 @@ ___ ▸ **on**(type: *[RpcRxInterface$Events](../modules/_types_.md#rpcrxinterface_events)*, handler: *`function`*): `void` -*Defined in [index.ts:63](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-rx/src/index.ts#L63)* +*Defined in [index.ts:63](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-rx/src/index.ts#L63)* **Parameters:** diff --git a/docs/rpc-rx/modules/_types_.md b/docs/rpc-rx/modules/_types_.md index 9967850bdd..df8958619a 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/1c6a89b/packages/rpc-rx/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/rpc-rx/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/rpc-rx/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/6eb859c/packages/rpc-rx/src/types.ts#L8)* #### Type declaration ▸(...params: *`Array`<`any`>*): `Observable`<`any`> @@ -48,7 +48,7 @@ ___ **Ƭ RpcRxInterface$Section**: *`object`* -*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/1c6a89b/packages/rpc-rx/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/6eb859c/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 278a9a8f89..3ff5ef75ab 100644 --- a/docs/type-extrinsics/modules/_frommetadata_.md +++ b/docs/type-extrinsics/modules/_frommetadata_.md @@ -8,7 +8,7 @@ ▸ **fromMetadata**(metadata: *`MetadataV0`*): `ModulesWithMethods` -*Defined in [fromMetadata.ts:21](https://github.com/polkadot-js/api/blob/1c6a89b/packages/type-extrinsics/src/fromMetadata.ts#L21)* +*Defined in [fromMetadata.ts:21](https://github.com/polkadot-js/api/blob/6eb859c/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 e62d4705a1..b7fed1aca0 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/1c6a89b/packages/type-extrinsics/src/utils/createUnchecked.ts#L16)* +*Defined in [utils/createUnchecked.ts:16](https://github.com/polkadot-js/api/blob/6eb859c/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 a28da9f17e..b916413da0 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/1c6a89b/packages/type-jsonrpc/src/create/method.ts#L9)* +*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/6eb859c/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 1e7fe0f86b..15e61beb3e 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/1c6a89b/packages/type-jsonrpc/src/create/param.ts#L12)* +*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/6eb859c/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 53dc1fcb24..9a42806377 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/1c6a89b/packages/type-jsonrpc/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/type-jsonrpc/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/type-jsonrpc/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/type-jsonrpc/src/types.ts#L38)* +*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/6eb859c/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 bd178dac70..44aee5b1df 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/1c6a89b/packages/type-storage/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/6eb859c/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 c5ab4a6501..1f0eb849c7 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:12](https://github.com/polkadot-js/api/blob/1c6a89b/packages/type-storage/src/utils/createFunction.ts#L12)* +*Defined in [utils/createFunction.ts:12](https://github.com/polkadot-js/api/blob/6eb859c/packages/type-storage/src/utils/createFunction.ts#L12)* ___ @@ -21,7 +21,7 @@ ___ **● key**: *`undefined` \| `string`* -*Defined in [utils/createFunction.ts:13](https://github.com/polkadot-js/api/blob/1c6a89b/packages/type-storage/src/utils/createFunction.ts#L13)* +*Defined in [utils/createFunction.ts:13](https://github.com/polkadot-js/api/blob/6eb859c/packages/type-storage/src/utils/createFunction.ts#L13)* ___ diff --git a/docs/type-storage/modules/_frommetadata_.md b/docs/type-storage/modules/_frommetadata_.md index ab7f8c97ba..25b5bab083 100644 --- a/docs/type-storage/modules/_frommetadata_.md +++ b/docs/type-storage/modules/_frommetadata_.md @@ -8,7 +8,7 @@ ▸ **fromMetadata**(metadata: *`MetadataV0`*): [Storage](../interfaces/_types_.storage.md) -*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/1c6a89b/packages/type-storage/src/fromMetadata.ts#L20)* +*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/6eb859c/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 7ec2df54fa..40374fb6da 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/1c6a89b/packages/type-storage/src/storage.ts#L8)* +*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/type-storage/src/storage.ts#L9)* +*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/6eb859c/packages/type-storage/src/storage.ts#L9)* ___ diff --git a/docs/type-storage/modules/_substrate_.md b/docs/type-storage/modules/_substrate_.md index 63b36a3730..ff60039a78 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:44](https://github.com/polkadot-js/api/blob/1c6a89b/packages/type-storage/src/substrate.ts#L44)* +*Defined in [substrate.ts:44](https://github.com/polkadot-js/api/blob/6eb859c/packages/type-storage/src/substrate.ts#L44)* ___ @@ -23,7 +23,7 @@ ___ type: 'u32' }) -*Defined in [substrate.ts:49](https://github.com/polkadot-js/api/blob/1c6a89b/packages/type-storage/src/substrate.ts#L49)* +*Defined in [substrate.ts:49](https://github.com/polkadot-js/api/blob/6eb859c/packages/type-storage/src/substrate.ts#L49)* ___ @@ -35,7 +35,7 @@ ___ type: 'u32' }) -*Defined in [substrate.ts:59](https://github.com/polkadot-js/api/blob/1c6a89b/packages/type-storage/src/substrate.ts#L59)* +*Defined in [substrate.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/type-storage/src/substrate.ts#L59)* ___ @@ -47,7 +47,7 @@ ___ type: 'Bytes' }) -*Defined in [substrate.ts:34](https://github.com/polkadot-js/api/blob/1c6a89b/packages/type-storage/src/substrate.ts#L34)* +*Defined in [substrate.ts:34](https://github.com/polkadot-js/api/blob/6eb859c/packages/type-storage/src/substrate.ts#L34)* ___ @@ -59,7 +59,7 @@ ___ type: 'u32' }) -*Defined in [substrate.ts:54](https://github.com/polkadot-js/api/blob/1c6a89b/packages/type-storage/src/substrate.ts#L54)* +*Defined in [substrate.ts:54](https://github.com/polkadot-js/api/blob/6eb859c/packages/type-storage/src/substrate.ts#L54)* ___ @@ -71,7 +71,7 @@ ___ type: 'u64' }) -*Defined in [substrate.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/type-storage/src/substrate.ts#L39)* +*Defined in [substrate.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/type-storage/src/substrate.ts#L39)* ___ diff --git a/docs/type-storage/modules/_utils_createfunction_.md b/docs/type-storage/modules/_utils_createfunction_.md index a1cd0cb0db..6ee9f21dbe 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:26](https://github.com/polkadot-js/api/blob/1c6a89b/packages/type-storage/src/utils/createFunction.ts#L26)* +*Defined in [utils/createFunction.ts:26](https://github.com/polkadot-js/api/blob/6eb859c/packages/type-storage/src/utils/createFunction.ts#L26)* 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/_codec_base_.base.html b/docs/types/classes/_codec_base_.base.html index c7253d69a1..a7e8183973 100644 --- a/docs/types/classes/_codec_base_.base.html +++ b/docs/types/classes/_codec_base_.base.html @@ -2151,7 +2151,7 @@

constructor

⊕ new Base(value?: any): Base

-

Defined in codec/Base.ts:10

+

Defined in codec/Base.ts:10

Parameters:

@@ -2212,7 +2212,7 @@ diff --git a/docs/types/classes/_codec_base_.base.md b/docs/types/classes/_codec_base_.base.md index 6d77323d93..383a8645db 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/1c6a89b/packages/types/src/codec/Base.ts#L10)* +*Defined in [codec/Base.ts:10](https://github.com/polkadot-js/api/blob/6eb859c/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 2d527adf92..5c7054d3fc 100644 --- a/docs/types/classes/_codec_compact_.compact.html +++ b/docs/types/classes/_codec_compact_.compact.html @@ -2150,7 +2150,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:

@@ -2181,32 +2181,32 @@

<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


isEmpty

getisEmpty(): boolean

-

Defined in codec/Compact.ts:79

+

Defined in codec/Compact.ts:79

description: Checks if the value is an empty value

Returns: boolean


@@ -2214,7 +2214,7 @@

bitLength

▸ bitLength(): UIntBitLength

-

Defined in codec/Compact.ts:86

+

Defined in codec/Compact.ts:86

description: Returns the number of bits in the value

Returns: UIntBitLength


@@ -2222,7 +2222,7 @@

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

-

Defined in codec/Compact.ts:93

+

Defined in codec/Compact.ts:93

description: Compares the value of the input to see if there is a match

Parameters:

@@ -2244,7 +2244,7 @@

toBn

▸ toBn(): BN

-

Defined in codec/Compact.ts:104

+

Defined in codec/Compact.ts:104

description: Returns the BN representation of the number

Returns: BN


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

toHex

▸ toHex(): any

Implementation of Codec.toHex

-

Defined in codec/Compact.ts:111

+

Defined in codec/Compact.ts:111

description: Returns a hex string representation of the value

Returns: any


@@ -2260,14 +2260,14 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Compact.ts:118

+

Defined in codec/Compact.ts:118

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

Returns: any


toNumber

▸ toNumber(): number

-

Defined in codec/Compact.ts:125

+

Defined in codec/Compact.ts:125

description: Returns the number representation for the value

Returns: number


@@ -2275,7 +2275,7 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/Compact.ts:132

+

Defined in codec/Compact.ts:132

description: Returns the string representation of the value

Returns: string


@@ -2283,7 +2283,7 @@

toU8a

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

Implementation of Codec.toU8a

-

Defined in codec/Compact.ts:140

+

Defined in codec/Compact.ts:140

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

Parameters:

@@ -2309,14 +2309,14 @@

unwrap

▸ unwrap(): UInt | Moment

-

Defined in codec/Compact.ts:147

+

Defined in codec/Compact.ts:147

description: Returns the embedded UInt or Moment value

Returns: UInt | Moment


<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:

@@ -2343,7 +2343,7 @@

<Static> stripLengthPrefix

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

-

Defined in codec/Compact.ts:45

+

Defined in codec/Compact.ts:45

Parameters:

@@ -2371,7 +2371,7 @@

<Static> with

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

-

Defined in codec/Compact.ts:28

+

Defined in codec/Compact.ts:28

Parameters:

@@ -2433,7 +2433,7 @@ diff --git a/docs/types/classes/_codec_compact_.compact.md b/docs/types/classes/_codec_compact_.compact.md index c5063f7a36..84587dc488 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/1c6a89b/packages/types/src/codec/Compact.ts#L23)* +*Defined in [codec/Compact.ts:23](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/types/src/codec/Compact.ts#L41)* +*Defined in [codec/Compact.ts:41](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L41)* Prepend a Uint8Array with its compact length. @@ -60,7 +60,7 @@ ___ **● decodeU8a**: *`compactFromU8a`* = compactFromU8a -*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L42)* +*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L42)* ___ @@ -69,7 +69,7 @@ ___ **● encodeU8a**: *`compactToU8a`* = compactToU8a -*Defined in [codec/Compact.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L43)* +*Defined in [codec/Compact.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L43)* ___ @@ -81,7 +81,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Compact.ts:72](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L72)* +*Defined in [codec/Compact.ts:72](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L72)* *__description__*: The length of the value when encoded as a Uint8Array @@ -94,7 +94,7 @@ ___ getisEmpty(): `boolean` -*Defined in [codec/Compact.ts:79](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L79)* +*Defined in [codec/Compact.ts:79](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L79)* *__description__*: Checks if the value is an empty value @@ -110,7 +110,7 @@ ___ ▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) -*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L86)* +*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L86)* *__description__*: Returns the number of bits in the value @@ -125,7 +125,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [codec/Compact.ts:93](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L93)* +*Defined in [codec/Compact.ts:93](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L93)* *__description__*: Compares the value of the input to see if there is a match @@ -144,7 +144,7 @@ ___ ▸ **toBn**(): `BN` -*Defined in [codec/Compact.ts:104](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L104)* +*Defined in [codec/Compact.ts:104](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L104)* *__description__*: Returns the BN representation of the number @@ -159,7 +159,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Compact.ts:111](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L111)* +*Defined in [codec/Compact.ts:111](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L111)* *__description__*: Returns a hex string representation of the value @@ -174,7 +174,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Compact.ts:118](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L118)* +*Defined in [codec/Compact.ts:118](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L118)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -187,7 +187,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [codec/Compact.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L125)* +*Defined in [codec/Compact.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L125)* *__description__*: Returns the number representation for the value @@ -202,7 +202,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [codec/Compact.ts:132](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L132)* +*Defined in [codec/Compact.ts:132](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L132)* *__description__*: Returns the string representation of the value @@ -217,7 +217,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [codec/Compact.ts:140](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L140)* +*Defined in [codec/Compact.ts:140](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L140)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -236,7 +236,7 @@ ___ ▸ **unwrap**(): [UInt](_codec_uint_.uint.md) \| [Moment](_primitive_moment_.moment.md) -*Defined in [codec/Compact.ts:147](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L147)* +*Defined in [codec/Compact.ts:147](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L147)* *__description__*: Returns the embedded [UInt](_codec_uint_.uint.md) or [Moment](_primitive_moment_.moment.md) value @@ -249,7 +249,7 @@ ___ ▸ **decodeCompact**(Type: *[Constructor](../interfaces/_types_.constructor.md)<[UInt](_codec_uint_.uint.md) \| [Moment](_primitive_moment_.moment.md)>*, value: *[Compact](_codec_compact_.compact.md) \| [AnyNumber](../modules/_types_.md#anynumber)*): [Moment](_primitive_moment_.moment.md) \| [UInt](_codec_uint_.uint.md) -*Defined in [codec/Compact.ts:51](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L51)* +*Defined in [codec/Compact.ts:51](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L51)* **Parameters:** @@ -267,7 +267,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/1c6a89b/packages/types/src/codec/Compact.ts#L45)* +*Defined in [codec/Compact.ts:45](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L45)* **Parameters:** @@ -285,7 +285,7 @@ ___ ▸ **with**(Type: *[Constructor](../interfaces/_types_.constructor.md)<[UInt](_codec_uint_.uint.md) \| [Moment](_primitive_moment_.moment.md)>*): [Constructor](../interfaces/_types_.constructor.md)<[Compact](_codec_compact_.compact.md)> -*Defined in [codec/Compact.ts:28](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L28)* +*Defined in [codec/Compact.ts:28](https://github.com/polkadot-js/api/blob/6eb859c/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 06f30b92e2..e35a47c40c 100644 --- a/docs/types/classes/_codec_enum_.enum.html +++ b/docs/types/classes/_codec_enum_.enum.html @@ -2152,7 +2152,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:

@@ -2184,14 +2184,14 @@

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


isEmpty

getisEmpty(): boolean

-

Defined in codec/Enum.ts:71

+

Defined in codec/Enum.ts:71

description: Checks if the value is an empty value (always false)

Returns: boolean


@@ -2200,7 +2200,7 @@

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

-

Defined in codec/Enum.ts:78

+

Defined in codec/Enum.ts:78

description: Compares the value of the input to see if there is a match

Parameters:

@@ -2223,7 +2223,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Enum.ts:91

+

Defined in codec/Enum.ts:91

description: Returns a hex string representation of the value

Returns: string


@@ -2231,14 +2231,14 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Enum.ts:98

+

Defined in codec/Enum.ts:98

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

Returns: any


toNumber

▸ toNumber(): number

-

Defined in codec/Enum.ts:105

+

Defined in codec/Enum.ts:105

description: Returns the number representation for the value

Returns: number


@@ -2246,7 +2246,7 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/Enum.ts:112

+

Defined in codec/Enum.ts:112

description: Returns the string representation of the value

Returns: string


@@ -2254,7 +2254,7 @@

toU8a

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

Implementation of Codec.toU8a

-

Defined in codec/Enum.ts:120

+

Defined in codec/Enum.ts:120

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

Parameters:

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

@@ -2348,7 +2348,7 @@ diff --git a/docs/types/classes/_codec_enum_.enum.md b/docs/types/classes/_codec_enum_.enum.md index 2c584d54c1..9eef12e10f 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/1c6a89b/packages/types/src/codec/Enum.ts#L29)* +*Defined in [codec/Enum.ts:29](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/types/src/codec/Enum.ts#L64)* +*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -64,7 +64,7 @@ ___ getisEmpty(): `boolean` -*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L71)* +*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L71)* *__description__*: Checks if the value is an empty value (always false) @@ -82,7 +82,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L78)* +*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L78)* *__description__*: Compares the value of the input to see if there is a match @@ -103,7 +103,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Enum.ts:91](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L91)* +*Defined in [codec/Enum.ts:91](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L91)* *__description__*: Returns a hex string representation of the value @@ -118,7 +118,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Enum.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L98)* +*Defined in [codec/Enum.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L98)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -131,7 +131,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [codec/Enum.ts:105](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L105)* +*Defined in [codec/Enum.ts:105](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L105)* *__description__*: Returns the number representation for the value @@ -146,7 +146,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [codec/Enum.ts:112](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L112)* +*Defined in [codec/Enum.ts:112](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L112)* *__description__*: Returns the string representation of the value @@ -161,7 +161,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [codec/Enum.ts:120](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L120)* +*Defined in [codec/Enum.ts:120](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L120)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -180,7 +180,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/1c6a89b/packages/types/src/codec/Enum.ts#L47)* +*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/6eb859c/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 eb64163405..1434e173c1 100644 --- a/docs/types/classes/_codec_enumtype_.enumtype.html +++ b/docs/types/classes/_codec_enumtype_.enumtype.html @@ -2159,7 +2159,7 @@

constructor

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

Overrides Base.constructor

-

Defined in codec/EnumType.ts:35

+

Defined in codec/EnumType.ts:35

Parameters:

@@ -2190,49 +2190,49 @@

encodedLength

getencodedLength(): number

-

Defined in codec/EnumType.ts:114

+

Defined in codec/EnumType.ts:114

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

Returns: number


index

getindex(): number

-

Defined in codec/EnumType.ts:121

+

Defined in codec/EnumType.ts:121

description: The index of the metadata value

Returns: number


isEmpty

getisEmpty(): boolean

-

Defined in codec/EnumType.ts:128

+

Defined in codec/EnumType.ts:128

description: Checks if the value is an empty value

Returns: boolean


isNone

getisNone(): boolean

-

Defined in codec/EnumType.ts:135

+

Defined in codec/EnumType.ts:135

description: Checks if the Enum points to a Null type

Returns: boolean


isNull

getisNull(): boolean

-

Defined in codec/EnumType.ts:142

+

Defined in codec/EnumType.ts:142

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

Returns: boolean


type

gettype(): string

-

Defined in codec/EnumType.ts:149

+

Defined in codec/EnumType.ts:149

description: The name of the type this enum value represents

Returns: string


value

getvalue(): Codec

-

Defined in codec/EnumType.ts:156

+

Defined in codec/EnumType.ts:156

description: The value of the enum

Returns: Codec


@@ -2241,7 +2241,7 @@

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

-

Defined in codec/EnumType.ts:163

+

Defined in codec/EnumType.ts:163

description: Compares the value of the input to see if there is a match

Parameters:

@@ -2264,7 +2264,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/EnumType.ts:176

+

Defined in codec/EnumType.ts:176

description: Returns a hex string representation of the value

Returns: string


@@ -2272,14 +2272,14 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/EnumType.ts:183

+

Defined in codec/EnumType.ts:183

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

Returns: any


toNumber

▸ toNumber(): number

-

Defined in codec/EnumType.ts:192

+

Defined in codec/EnumType.ts:192

description: Returns the number representation for the value

Returns: number


@@ -2287,7 +2287,7 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/EnumType.ts:199

+

Defined in codec/EnumType.ts:199

description: Returns the string representation of the value

Returns: string


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

toU8a

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

Implementation of Codec.toU8a

-

Defined in codec/EnumType.ts:209

+

Defined in codec/EnumType.ts:209

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

Parameters:

@@ -2321,7 +2321,7 @@

<Static> with

▸ with<S>(Types: S): EnumConstructor<EnumType<S>>

-

Defined in codec/EnumType.ts:101

+

Defined in codec/EnumType.ts:101

Type parameters:

S : ConstructorDef

Parameters:

@@ -2384,7 +2384,7 @@ diff --git a/docs/types/classes/_codec_enumtype_.enumtype.md b/docs/types/classes/_codec_enumtype_.enumtype.md index 8ac992733c..add615a603 100644 --- a/docs/types/classes/_codec_enumtype_.enumtype.md +++ b/docs/types/classes/_codec_enumtype_.enumtype.md @@ -42,7 +42,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [codec/EnumType.ts:35](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L35)* +*Defined in [codec/EnumType.ts:35](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L35)* **Parameters:** @@ -64,7 +64,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L114)* +*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L114)* *__description__*: The length of the value when encoded as a Uint8Array @@ -77,7 +77,7 @@ ___ getindex(): `number` -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L121)* +*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L121)* *__description__*: The index of the metadata value @@ -90,7 +90,7 @@ ___ getisEmpty(): `boolean` -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L128)* +*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L128)* *__description__*: Checks if the value is an empty value @@ -103,7 +103,7 @@ ___ getisNone(): `boolean` -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L135)* +*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L135)* *__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type @@ -116,7 +116,7 @@ ___ getisNull(): `boolean` -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L142)* +*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L142)* *__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type (deprecated, use isNone) @@ -129,7 +129,7 @@ ___ gettype(): `string` -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L149)* +*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L149)* *__description__*: The name of the type this enum value represents @@ -142,7 +142,7 @@ ___ getvalue(): [Codec](../interfaces/_types_.codec.md) -*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L156)* +*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L156)* *__description__*: The value of the enum @@ -160,7 +160,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L163)* +*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L163)* *__description__*: Compares the value of the input to see if there is a match @@ -181,7 +181,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L176)* +*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L176)* *__description__*: Returns a hex string representation of the value @@ -196,7 +196,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L183)* +*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L183)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -209,7 +209,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L192)* +*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L192)* *__description__*: Returns the number representation for the value @@ -224,7 +224,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [codec/EnumType.ts:199](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L199)* +*Defined in [codec/EnumType.ts:199](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L199)* *__description__*: Returns the string representation of the value @@ -239,7 +239,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L209)* +*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -258,7 +258,7 @@ ___ ▸ **with**<`S`>(Types: *`S`*): `EnumConstructor`<[EnumType](_codec_enumtype_.enumtype.md)<`S`>> -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L101)* +*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L101)* **Type parameters:** diff --git a/docs/types/classes/_codec_int_.int.md b/docs/types/classes/_codec_int_.int.md index 4a66ba982a..92fa1ae6a1 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/1c6a89b/packages/types/src/codec/Int.ts#L21)* +*Defined in [codec/Int.ts:21](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -79,7 +79,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/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 055b20c270..82c3812435 100644 --- a/docs/types/classes/_codec_option_.option.html +++ b/docs/types/classes/_codec_option_.option.html @@ -2151,7 +2151,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:

@@ -2177,35 +2177,35 @@

encodedLength

getencodedLength(): number

-

Defined in codec/Option.ts:51

+

Defined in codec/Option.ts:51

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

Returns: number


isEmpty

getisEmpty(): boolean

-

Defined in codec/Option.ts:59

+

Defined in codec/Option.ts:59

description: Checks if the Option has no value

Returns: boolean


isNone

getisNone(): boolean

-

Defined in codec/Option.ts:66

+

Defined in codec/Option.ts:66

description: Checks if the Option has no value

Returns: boolean


isSome

getisSome(): boolean

-

Defined in codec/Option.ts:73

+

Defined in codec/Option.ts:73

description: Checks if the Option has a value

Returns: boolean


value

getvalue(): Codec

-

Defined in codec/Option.ts:80

+

Defined in codec/Option.ts:80

description: The actual value for the Option

Returns: Codec


@@ -2214,7 +2214,7 @@

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

-

Defined in codec/Option.ts:87

+

Defined in codec/Option.ts:87

description: Compares the value of the input to see if there is a match

Parameters:

@@ -2237,7 +2237,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Option.ts:98

+

Defined in codec/Option.ts:98

description: Returns a hex string representation of the value

Returns: string


@@ -2245,7 +2245,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Option.ts:105

+

Defined in codec/Option.ts:105

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

Returns: any


@@ -2253,7 +2253,7 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/Option.ts:112

+

Defined in codec/Option.ts:112

description: Returns the string representation of the value

Returns: string


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

toU8a

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

Implementation of Codec.toU8a

-

Defined in codec/Option.ts:120

+

Defined in codec/Option.ts:120

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

Parameters:

@@ -2287,14 +2287,14 @@

unwrap

▸ unwrap(): T

-

Defined in codec/Option.ts:138

+

Defined in codec/Option.ts:138

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

Returns: T


unwrapOr

▸ unwrapOr<O>(defaultValue: O): T | O

-

Defined in codec/Option.ts:150

+

Defined in codec/Option.ts:150

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

Type parameters:

O

@@ -2320,7 +2320,7 @@

<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:

@@ -2347,7 +2347,7 @@

<Static> with

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

-

Defined in codec/Option.ts:40

+

Defined in codec/Option.ts:40

Type parameters:

O : Codec

Parameters:

@@ -2410,7 +2410,7 @@ diff --git a/docs/types/classes/_codec_option_.option.md b/docs/types/classes/_codec_option_.option.md index 81ce044646..b9054ab207 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/1c6a89b/packages/types/src/codec/Option.ts#L19)* +*Defined in [codec/Option.ts:19](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Option.ts#L19)* **Parameters:** @@ -47,7 +47,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Option.ts:51](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Option.ts#L51)* +*Defined in [codec/Option.ts:51](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Option.ts#L51)* *__description__*: The length of the value when encoded as a Uint8Array @@ -60,7 +60,7 @@ ___ getisEmpty(): `boolean` -*Defined in [codec/Option.ts:59](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Option.ts#L59)* +*Defined in [codec/Option.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Option.ts#L59)* *__description__*: Checks if the Option has no value @@ -73,7 +73,7 @@ ___ getisNone(): `boolean` -*Defined in [codec/Option.ts:66](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Option.ts#L66)* +*Defined in [codec/Option.ts:66](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Option.ts#L66)* *__description__*: Checks if the Option has no value @@ -86,7 +86,7 @@ ___ getisSome(): `boolean` -*Defined in [codec/Option.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Option.ts#L73)* +*Defined in [codec/Option.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Option.ts#L73)* *__description__*: Checks if the Option has a value @@ -99,7 +99,7 @@ ___ getvalue(): [Codec](../interfaces/_types_.codec.md) -*Defined in [codec/Option.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Option.ts#L80)* +*Defined in [codec/Option.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Option.ts#L80)* *__description__*: The actual value for the Option @@ -117,7 +117,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [codec/Option.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Option.ts#L87)* +*Defined in [codec/Option.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Option.ts#L87)* *__description__*: Compares the value of the input to see if there is a match @@ -138,7 +138,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Option.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Option.ts#L98)* +*Defined in [codec/Option.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Option.ts#L98)* *__description__*: Returns a hex string representation of the value @@ -153,7 +153,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Option.ts:105](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Option.ts#L105)* +*Defined in [codec/Option.ts:105](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Option.ts#L105)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -168,7 +168,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [codec/Option.ts:112](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Option.ts#L112)* +*Defined in [codec/Option.ts:112](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Option.ts#L112)* *__description__*: Returns the string representation of the value @@ -183,7 +183,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [codec/Option.ts:120](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Option.ts#L120)* +*Defined in [codec/Option.ts:120](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Option.ts#L120)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -202,7 +202,7 @@ ___ ▸ **unwrap**(): `T` -*Defined in [codec/Option.ts:138](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Option.ts#L138)* +*Defined in [codec/Option.ts:138](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Option.ts#L138)* *__description__*: Returns the value that the Option represents (if available), throws if null @@ -215,7 +215,7 @@ ___ ▸ **unwrapOr**<`O`>(defaultValue: *`O`*): `T` \| `O` -*Defined in [codec/Option.ts:150](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Option.ts#L150)* +*Defined in [codec/Option.ts:150](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Option.ts#L150)* *__description__*: Returns the value that the Option represents (if available) or defaultValue if none @@ -237,7 +237,7 @@ ___ ▸ **decodeOption**<`O`>(Type: *[Constructor](../interfaces/_types_.constructor.md)*, value?: *`any`*): [Codec](../interfaces/_types_.codec.md) -*Defined in [codec/Option.ts:26](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Option.ts#L26)* +*Defined in [codec/Option.ts:26](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Option.ts#L26)* **Type parameters:** @@ -258,7 +258,7 @@ ___ ▸ **with**<`O`>(Type: *[Constructor](../interfaces/_types_.constructor.md)*): [Constructor](../interfaces/_types_.constructor.md)<[Option](_codec_option_.option.md)<`O`>> -*Defined in [codec/Option.ts:40](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Option.ts#L40)* +*Defined in [codec/Option.ts:40](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Option.ts#L40)* **Type parameters:** diff --git a/docs/types/classes/_codec_set_.set.html b/docs/types/classes/_codec_set_.set.html index f49930720a..af1ff1a23f 100644 --- a/docs/types/classes/_codec_set_.set.html +++ b/docs/types/classes/_codec_set_.set.html @@ -2149,7 +2149,7 @@

constructor

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

Overrides Base.constructor

-

Defined in codec/Set.ts:23

+

Defined in codec/Set.ts:23

Parameters:

@@ -2177,28 +2177,28 @@

encodedLength

getencodedLength(): number

-

Defined in codec/Set.ts:73

+

Defined in codec/Set.ts:73

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

Returns: number


isEmpty

getisEmpty(): boolean

-

Defined in codec/Set.ts:80

+

Defined in codec/Set.ts:80

description: true is the Set contains no values

Returns: boolean


valueEncoded

getvalueEncoded(): number

-

Defined in codec/Set.ts:94

+

Defined in codec/Set.ts:94

description: The encoded value for the set members

Returns: number


values

getvalues(): Array<string>

-

Defined in codec/Set.ts:87

+

Defined in codec/Set.ts:87

description: The actual set values as a Array

Returns: Array<string>


@@ -2207,7 +2207,7 @@

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

-

Defined in codec/Set.ts:101

+

Defined in codec/Set.ts:101

description: Compares the value of the input to see if there is a match

Parameters:

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

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Set.ts:117

+

Defined in codec/Set.ts:117

description: Returns a hex string representation of the value

Returns: string


@@ -2238,7 +2238,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Set.ts:124

+

Defined in codec/Set.ts:124

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

Returns: any


@@ -2246,7 +2246,7 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/Set.ts:131

+

Defined in codec/Set.ts:131

description: Returns the string representation of the value

Returns: string


@@ -2254,7 +2254,7 @@

toU8a

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

Implementation of Codec.toU8a

-

Defined in codec/Set.ts:139

+

Defined in codec/Set.ts:139

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

Parameters:

@@ -2280,7 +2280,7 @@

<Static> decodeSet

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

-

Defined in codec/Set.ts:33

+

Defined in codec/Set.ts:33

Parameters:

@@ -2310,7 +2310,7 @@

<Static> encodeSet

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

-

Defined in codec/Set.ts:64

+

Defined in codec/Set.ts:64

Parameters:

@@ -2375,7 +2375,7 @@ diff --git a/docs/types/classes/_codec_set_.set.md b/docs/types/classes/_codec_set_.set.md index ec53125c70..4774765866 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:23](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Set.ts#L23)* +*Defined in [codec/Set.ts:23](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Set.ts#L23)* **Parameters:** @@ -45,7 +45,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Set.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Set.ts#L73)* +*Defined in [codec/Set.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Set.ts#L73)* *__description__*: The length of the value when encoded as a Uint8Array @@ -58,7 +58,7 @@ ___ getisEmpty(): `boolean` -*Defined in [codec/Set.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Set.ts#L80)* +*Defined in [codec/Set.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Set.ts#L80)* *__description__*: true is the Set contains no values @@ -71,7 +71,7 @@ ___ getvalueEncoded(): `number` -*Defined in [codec/Set.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Set.ts#L94)* +*Defined in [codec/Set.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Set.ts#L94)* *__description__*: The encoded value for the set members @@ -84,7 +84,7 @@ ___ getvalues(): `Array`<`string`> -*Defined in [codec/Set.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Set.ts#L87)* +*Defined in [codec/Set.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Set.ts#L87)* *__description__*: The actual set values as a Array @@ -102,7 +102,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [codec/Set.ts:101](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Set.ts#L101)* +*Defined in [codec/Set.ts:101](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Set.ts#L101)* *__description__*: Compares the value of the input to see if there is a match @@ -123,7 +123,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Set.ts:117](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Set.ts#L117)* +*Defined in [codec/Set.ts:117](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Set.ts#L117)* *__description__*: Returns a hex string representation of the value @@ -138,7 +138,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Set.ts:124](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Set.ts#L124)* +*Defined in [codec/Set.ts:124](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Set.ts#L124)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -153,7 +153,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [codec/Set.ts:131](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Set.ts#L131)* +*Defined in [codec/Set.ts:131](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Set.ts#L131)* *__description__*: Returns the string representation of the value @@ -168,7 +168,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [codec/Set.ts:139](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Set.ts#L139)* +*Defined in [codec/Set.ts:139](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Set.ts#L139)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -187,7 +187,7 @@ ___ ▸ **decodeSet**(setValues: *`SetValues`*, value?: *`Array`<`string`> \| `Uint8Array` \| `number`*): `Array`<`string`> -*Defined in [codec/Set.ts:33](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Set.ts#L33)* +*Defined in [codec/Set.ts:33](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Set.ts#L33)* **Parameters:** @@ -205,7 +205,7 @@ ___ ▸ **encodeSet**(setValues: *`SetValues`*, value: *`Array`<`string`>*): `number` -*Defined in [codec/Set.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Set.ts#L64)* +*Defined in [codec/Set.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Set.ts#L64)* **Parameters:** diff --git a/docs/types/classes/_codec_struct_.struct.html b/docs/types/classes/_codec_struct_.struct.html index 26c948168c..aba387c436 100644 --- a/docs/types/classes/_codec_struct_.struct.html +++ b/docs/types/classes/_codec_struct_.struct.html @@ -2201,7 +2201,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:

@@ -2243,21 +2243,21 @@

Type

getType(): E

-

Defined in codec/Struct.ts:160

+

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E


encodedLength

getencodedLength(): number

-

Defined in codec/Struct.ts:167

+

Defined in codec/Struct.ts:167

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

Returns: number


isEmpty

getisEmpty(): boolean

-

Defined in codec/Struct.ts:145

+

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean


@@ -2266,7 +2266,7 @@

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

-

Defined in codec/Struct.ts:176

+

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

@@ -2289,7 +2289,7 @@

get

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

Overrides Map.get

-

Defined in codec/Struct.ts:184

+

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

@@ -2313,7 +2313,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

-

Defined in codec/Struct.ts:191

+

Defined in codec/Struct.ts:191

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

Parameters:

@@ -2335,7 +2335,7 @@

toArray

▸ toArray(): Array<Codec>

-

Defined in codec/Struct.ts:198

+

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2343,7 +2343,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Struct.ts:205

+

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string


@@ -2351,7 +2351,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Struct.ts:212

+

Defined in codec/Struct.ts:212

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

Returns: any


@@ -2359,7 +2359,7 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/Struct.ts:226

+

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string


@@ -2367,7 +2367,7 @@

toU8a

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

Implementation of Codec.toU8a

-

Defined in codec/Struct.ts:234

+

Defined in codec/Struct.ts:234

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

Parameters:

@@ -2393,7 +2393,7 @@

<Static> with

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

-

Defined in codec/Struct.ts:125

+

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

@@ -2456,7 +2456,7 @@ diff --git a/docs/types/classes/_codec_struct_.struct.md b/docs/types/classes/_codec_struct_.struct.md index 2f478c1a73..1080c3d100 100644 --- a/docs/types/classes/_codec_struct_.struct.md +++ b/docs/types/classes/_codec_struct_.struct.md @@ -123,7 +123,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/1c6a89b/packages/types/src/codec/Struct.ts#L31)* +*Defined in [codec/Struct.ts:31](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L31)* **Parameters:** @@ -157,7 +157,7 @@ ___ getType(): `E` -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -170,7 +170,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -183,7 +183,7 @@ ___ getisEmpty(): `boolean` -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -201,7 +201,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -222,7 +222,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -241,7 +241,7 @@ ___ ▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -260,7 +260,7 @@ ___ ▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -275,7 +275,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -290,7 +290,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -305,7 +305,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -320,7 +320,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -339,7 +339,7 @@ ___ ▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_codec_tuple_.tuple.html b/docs/types/classes/_codec_tuple_.tuple.html index 8214dc30b1..4d9572e7b5 100644 --- a/docs/types/classes/_codec_tuple_.tuple.html +++ b/docs/types/classes/_codec_tuple_.tuple.html @@ -2163,7 +2163,7 @@

constructor

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

-

Defined in codec/Tuple.ts:22

+

Defined in codec/Tuple.ts:22

Parameters:

@@ -2195,21 +2195,21 @@

Types

getTypes(): Array<string>

-

Defined in codec/Tuple.ts:75

+

Defined in codec/Tuple.ts:75

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


isEmpty

getisEmpty(): boolean

-

Defined in codec/Tuple.ts:68

+

Defined in codec/Tuple.ts:68

description: Checks if the value is an empty value

Returns: boolean


@@ -2218,7 +2218,7 @@

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

-

Defined in codec/Tuple.ts:84

+

Defined in codec/Tuple.ts:84

description: Compares the value of the input to see if there is a match

Parameters:

@@ -2241,7 +2241,7 @@

filter

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

Overrides Array.filter

-

Defined in codec/Tuple.ts:140

+

Defined in codec/Tuple.ts:140

description: Filters the array with the callback

Parameters:

@@ -2271,7 +2271,7 @@

map

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

Overrides Array.map

-

Defined in codec/Tuple.ts:149

+

Defined in codec/Tuple.ts:149

description: Maps the array with the callback

Type parameters:

U

@@ -2302,7 +2302,7 @@

toArray

▸ toArray(): Array<Codec>

-

Defined in codec/Tuple.ts:91

+

Defined in codec/Tuple.ts:91

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2310,7 +2310,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Tuple.ts:98

+

Defined in codec/Tuple.ts:98

description: Returns a hex string representation of the value

Returns: string


@@ -2318,7 +2318,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Tuple.ts:105

+

Defined in codec/Tuple.ts:105

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

Returns: any


@@ -2327,7 +2327,7 @@

▸ toString(): string

Implementation of Codec.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:114

+

Defined in codec/Tuple.ts:114

description: Returns the string representation of the value

Returns: string


@@ -2335,7 +2335,7 @@

toU8a

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

Implementation of Codec.toU8a

-

Defined in codec/Tuple.ts:123

+

Defined in codec/Tuple.ts:123

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

Parameters:

@@ -2361,7 +2361,7 @@

<Static> with

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

-

Defined in codec/Tuple.ts:48

+

Defined in codec/Tuple.ts:48

Parameters:

@@ -2422,7 +2422,7 @@ diff --git a/docs/types/classes/_codec_tuple_.tuple.md b/docs/types/classes/_codec_tuple_.tuple.md index 27e4630205..577f59c543 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/1c6a89b/packages/types/src/codec/Tuple.ts#L22)* +*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L22)* **Parameters:** @@ -84,7 +84,7 @@ ___ getTypes(): `Array`<`string`> -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L75)* +*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L75)* *__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/1c6a89b/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -110,7 +110,7 @@ ___ getisEmpty(): `boolean` -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L68)* *__description__*: Checks if the value is an empty value @@ -128,7 +128,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Compares the value of the input to see if there is a match @@ -149,7 +149,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L140)* +*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L140)* *__description__*: Filters the array with the callback @@ -171,7 +171,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L149)* +*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L149)* *__description__*: Maps the array with the callback @@ -194,7 +194,7 @@ ___ ▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to an standard JavaScript Array @@ -209,7 +209,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Returns a hex string representation of the value @@ -224,7 +224,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L105)* +*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L105)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -241,7 +241,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L114)* +*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L114)* *__description__*: Returns the string representation of the value @@ -256,7 +256,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L123)* +*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L123)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -275,7 +275,7 @@ ___ ▸ **with**(Types: *`TupleConstructors`*): [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/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 9665c9c4bc..83cd9b8b0f 100644 --- a/docs/types/classes/_codec_typeregistry_.typeregistry.html +++ b/docs/types/classes/_codec_typeregistry_.typeregistry.html @@ -2141,13 +2141,13 @@

<Static> defaultRegistry

● defaultRegistry: TypeRegistry = new TypeRegistry()

-

Defined in codec/typeRegistry.ts:12

+

Defined in codec/typeRegistry.ts:12


Methods

get

▸ get(name: string): Constructor | undefined

-

Defined in codec/typeRegistry.ts:47

+

Defined in codec/typeRegistry.ts:47

Parameters:

@@ -2169,7 +2169,7 @@

register

▸ register(type: Constructor | RegistryTypes): void

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

-

Defined in codec/typeRegistry.ts:16

+

Defined in codec/typeRegistry.ts:16

Parameters:

@@ -2187,7 +2187,7 @@

Returns: void

-

Defined in codec/typeRegistry.ts:17

+

Defined in codec/typeRegistry.ts:17

Parameters:

@@ -2252,7 +2252,7 @@ diff --git a/docs/types/classes/_codec_typeregistry_.typeregistry.md b/docs/types/classes/_codec_typeregistry_.typeregistry.md index d89da06239..a485f1aa2f 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:12](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/typeRegistry.ts#L12)* +*Defined in [codec/typeRegistry.ts:12](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/typeRegistry.ts#L12)* ___ @@ -24,7 +24,7 @@ ___ ▸ **get**(name: *`string`*): [Constructor](../interfaces/_types_.constructor.md) \| `undefined` -*Defined in [codec/typeRegistry.ts:47](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/typeRegistry.ts#L47)* +*Defined in [codec/typeRegistry.ts:47](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/typeRegistry.ts#L47)* **Parameters:** @@ -43,7 +43,7 @@ ___ ▸ **register**(name: *`string`*, type: *[Constructor](../interfaces/_types_.constructor.md)*): `void` -*Defined in [codec/typeRegistry.ts:16](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/typeRegistry.ts#L16)* +*Defined in [codec/typeRegistry.ts:16](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/typeRegistry.ts#L16)* **Parameters:** @@ -53,7 +53,7 @@ ___ **Returns:** `void` -*Defined in [codec/typeRegistry.ts:17](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/typeRegistry.ts#L17)* +*Defined in [codec/typeRegistry.ts:17](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/typeRegistry.ts#L17)* **Parameters:** diff --git a/docs/types/classes/_codec_u8a_.u8a.html b/docs/types/classes/_codec_u8a_.u8a.html index b16ac6de1b..a866a676a2 100644 --- a/docs/types/classes/_codec_u8a_.u8a.html +++ b/docs/types/classes/_codec_u8a_.u8a.html @@ -2154,7 +2154,7 @@

constructor

⊕ new U8a(value?: AnyU8a): U8a

-

Defined in codec/U8a.ts:18

+

Defined in codec/U8a.ts:18

Parameters:

@@ -2182,14 +2182,14 @@

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


isEmpty

getisEmpty(): boolean

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


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

length

getlength(): number

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


@@ -2206,7 +2206,7 @@

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

-

Defined in codec/U8a.ts:58

+

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

@@ -2229,7 +2229,7 @@

subarray

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

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

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

Parameters:

@@ -2260,7 +2260,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2268,7 +2268,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/U8a.ts:87

+

Defined in codec/U8a.ts:87

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

Returns: any


@@ -2277,7 +2277,7 @@

▸ toString(): string

Implementation of Codec.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:94

+

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string


@@ -2285,7 +2285,7 @@

toU8a

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

Implementation of Codec.toU8a

-

Defined in codec/U8a.ts:102

+

Defined in codec/U8a.ts:102

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

Parameters:

@@ -2351,7 +2351,7 @@ diff --git a/docs/types/classes/_codec_u8a_.u8a.md b/docs/types/classes/_codec_u8a_.u8a.md index 3a90c51583..111d6fa193 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/1c6a89b/packages/types/src/codec/U8a.ts#L18)* +*Defined in [codec/U8a.ts:18](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -78,7 +78,7 @@ ___ getisEmpty(): `boolean` -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -93,7 +93,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -111,7 +111,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -132,7 +132,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -154,7 +154,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -169,7 +169,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -186,7 +186,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -201,7 +201,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__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 75df754041..6234b9b564 100644 --- a/docs/types/classes/_codec_u8afixed_.u8afixed.html +++ b/docs/types/classes/_codec_u8afixed_.u8afixed.html @@ -2158,7 +2158,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:

@@ -2223,7 +2223,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


@@ -2231,7 +2231,7 @@

isEmpty

getisEmpty(): boolean

Inherited from U8a.isEmpty

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean


@@ -2240,7 +2240,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:50

+

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number


@@ -2255,7 +2255,7 @@

bitLength

▸ bitLength(): number

-

Defined in codec/U8aFixed.ts:52

+

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number


@@ -2308,7 +2308,7 @@

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

-

Defined in codec/U8a.ts:58

+

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

@@ -2957,7 +2957,7 @@

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

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:73

+

Defined in codec/U8a.ts:73

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

Parameters:

@@ -2989,7 +2989,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:80

+

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string


@@ -2998,7 +2998,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:87

+

Defined in codec/U8a.ts:87

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

Returns: any


@@ -3016,7 +3016,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:94

+

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string


@@ -3025,7 +3025,7 @@

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

Implementation of Codec.toU8a

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:102

+

Defined in codec/U8a.ts:102

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

Parameters:

@@ -3099,7 +3099,7 @@ diff --git a/docs/types/classes/_codec_u8afixed_.u8afixed.md b/docs/types/classes/_codec_u8afixed_.u8afixed.md index 2227b00d3a..bc5fd6c638 100644 --- a/docs/types/classes/_codec_u8afixed_.u8afixed.md +++ b/docs/types/classes/_codec_u8afixed_.u8afixed.md @@ -41,7 +41,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/1c6a89b/packages/types/src/codec/U8aFixed.ts#L19)* +*Defined in [codec/U8aFixed.ts:19](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L19)* **Parameters:** @@ -130,7 +130,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/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -145,7 +145,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -162,7 +162,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -191,7 +191,7 @@ ___ ▸ **bitLength**(): `number` -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -246,7 +246,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -740,7 +740,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -764,7 +764,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -781,7 +781,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -815,7 +815,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -832,7 +832,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__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 1ef8fcec08..6f337ebb57 100644 --- a/docs/types/classes/_codec_uint_.uint.html +++ b/docs/types/classes/_codec_uint_.uint.html @@ -2155,7 +2155,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:

@@ -2191,7 +2191,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


@@ -2200,7 +2200,7 @@

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

Implementation of Codec.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:

@@ -2266,7 +2266,7 @@ diff --git a/docs/types/classes/_codec_uint_.uint.md b/docs/types/classes/_codec_uint_.uint.md index fc2a2e91e4..33e31e6bed 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/1c6a89b/packages/types/src/codec/UInt.ts#L21)* +*Defined in [codec/UInt.ts:21](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -79,7 +79,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/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 3a7e65745a..299a141a37 100644 --- a/docs/types/classes/_codec_vector_.vector.html +++ b/docs/types/classes/_codec_vector_.vector.html @@ -2155,7 +2155,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:

@@ -2193,21 +2193,21 @@

Type

getType(): string

-

Defined in codec/Vector.ts:66

+

Defined in codec/Vector.ts:66

description: The type for the items

Returns: string


encodedLength

getencodedLength(): number

-

Defined in codec/Vector.ts:73

+

Defined in codec/Vector.ts:73

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

Returns: number


isEmpty

getisEmpty(): boolean

-

Defined in codec/Vector.ts:59

+

Defined in codec/Vector.ts:59

description: Checks if the value is an empty value

Returns: boolean


@@ -2215,7 +2215,7 @@

length

getlength(): number

Overrides Array.length

-

Defined in codec/Vector.ts:82

+

Defined in codec/Vector.ts:82

description: The length of the value

Returns: number


@@ -2224,7 +2224,7 @@

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

-

Defined in codec/Vector.ts:90

+

Defined in codec/Vector.ts:90

description: Compares the value of the input to see if there is a match

Parameters:

@@ -2247,7 +2247,7 @@

filter

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

Overrides Array.filter

-

Defined in codec/Vector.ts:173

+

Defined in codec/Vector.ts:173

description: Filters the array with the callback

Parameters:

@@ -2277,7 +2277,7 @@

indexOf

▸ indexOf(_other?: any): number

Overrides Array.indexOf

-

Defined in codec/Vector.ts:97

+

Defined in codec/Vector.ts:97

description: Finds the index of the value in the array

Parameters:

@@ -2300,7 +2300,7 @@

map

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

Overrides Array.map

-

Defined in codec/Vector.ts:182

+

Defined in codec/Vector.ts:182

description: Maps the array with the callback

Type parameters:

U

@@ -2331,7 +2331,7 @@

toArray

▸ toArray(): Array<T>

-

Defined in codec/Vector.ts:115

+

Defined in codec/Vector.ts:115

description: Converts the Object to an standard JavaScript Array

Returns: Array<T>


@@ -2339,7 +2339,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Vector.ts:122

+

Defined in codec/Vector.ts:122

description: Returns a hex string representation of the value

Returns: string


@@ -2347,7 +2347,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Vector.ts:129

+

Defined in codec/Vector.ts:129

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

Returns: any


@@ -2356,7 +2356,7 @@

▸ toString(): string

Implementation of Codec.toString

Overrides Array.toString

-

Defined in codec/Vector.ts:138

+

Defined in codec/Vector.ts:138

description: Returns the string representation of the value

Returns: string


@@ -2364,7 +2364,7 @@

toU8a

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

Implementation of Codec.toU8a

-

Defined in codec/Vector.ts:151

+

Defined in codec/Vector.ts:151

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

Parameters:

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

@@ -2420,7 +2420,7 @@

<Static> with

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

-

Defined in codec/Vector.ts:48

+

Defined in codec/Vector.ts:48

Type parameters:

O : Codec

Parameters:

@@ -2483,7 +2483,7 @@ diff --git a/docs/types/classes/_codec_vector_.vector.md b/docs/types/classes/_codec_vector_.vector.md index a169d0650b..840fcdf7f4 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](../interfaces/_types_.constructor.md)<`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/1c6a89b/packages/types/src/codec/Vector.ts#L22)* +*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L22)* **Parameters:** @@ -66,7 +66,7 @@ ___ getType(): `string` -*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L66)* +*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L66)* *__description__*: The type for the items @@ -79,7 +79,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L73)* +*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L73)* *__description__*: The length of the value when encoded as a Uint8Array @@ -92,7 +92,7 @@ ___ getisEmpty(): `boolean` -*Defined in [codec/Vector.ts:59](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L59)* +*Defined in [codec/Vector.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L59)* *__description__*: Checks if the value is an empty value @@ -107,7 +107,7 @@ getlength(): `number` *Overrides Array.length* -*Defined in [codec/Vector.ts:82](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L82)* +*Defined in [codec/Vector.ts:82](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L82)* *__description__*: The length of the value @@ -125,7 +125,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [codec/Vector.ts:90](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L90)* +*Defined in [codec/Vector.ts:90](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L90)* *__description__*: Compares the value of the input to see if there is a match @@ -146,7 +146,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Vector.ts:173](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L173)* +*Defined in [codec/Vector.ts:173](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L173)* *__description__*: Filters the array with the callback @@ -168,7 +168,7 @@ ___ *Overrides Array.indexOf* -*Defined in [codec/Vector.ts:97](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L97)* +*Defined in [codec/Vector.ts:97](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L97)* *__description__*: Finds the index of the value in the array @@ -189,7 +189,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Vector.ts:182](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L182)* +*Defined in [codec/Vector.ts:182](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L182)* *__description__*: Maps the array with the callback @@ -212,7 +212,7 @@ ___ ▸ **toArray**(): `Array`<`T`> -*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L115)* +*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L115)* *__description__*: Converts the Object to an standard JavaScript Array @@ -227,7 +227,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Vector.ts:122](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L122)* +*Defined in [codec/Vector.ts:122](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L122)* *__description__*: Returns a hex string representation of the value @@ -242,7 +242,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L129)* +*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L129)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -259,7 +259,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Vector.ts:138](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L138)* +*Defined in [codec/Vector.ts:138](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L138)* *__description__*: Returns the string representation of the value @@ -274,7 +274,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [codec/Vector.ts:151](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L151)* +*Defined in [codec/Vector.ts:151](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L151)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -293,7 +293,7 @@ ___ ▸ **decodeVector**<`T`>(Type: *[Constructor](../interfaces/_types_.constructor.md)<`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/1c6a89b/packages/types/src/codec/Vector.ts#L32)* +*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L32)* **Type parameters:** @@ -314,7 +314,7 @@ ___ ▸ **with**<`O`>(Type: *[Constructor](../interfaces/_types_.constructor.md)<`O`>*): [Constructor](../interfaces/_types_.constructor.md)<[Vector](_codec_vector_.vector.md)<`O`>> -*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L48)* +*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L48)* **Type parameters:** diff --git a/docs/types/classes/_metadata_index_.metadata.md b/docs/types/classes/_metadata_index_.metadata.md index cec706b00d..50f603d247 100644 --- a/docs/types/classes/_metadata_index_.metadata.md +++ b/docs/types/classes/_metadata_index_.metadata.md @@ -30,7 +30,7 @@ *Overrides [MetadataVersioned](_metadata_metadataversioned_.metadataversioned.md).[constructor](_metadata_metadataversioned_.metadataversioned.md#constructor)* -*Defined in [Metadata/index.ts:15](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/index.ts#L15)* +*Defined in [Metadata/index.ts:15](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/index.ts#L15)* **Parameters:** @@ -77,7 +77,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -92,7 +92,7 @@ getasV0(): [MetadataV0](_metadata_v0_index_.metadatav0.md) *Inherited from [MetadataVersioned](_metadata_metadataversioned_.metadataversioned.md).[asV0](_metadata_metadataversioned_.metadataversioned.md#asv0)* -*Defined in [Metadata/MetadataVersioned.ts:86](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/MetadataVersioned.ts#L86)* +*Defined in [Metadata/MetadataVersioned.ts:86](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/MetadataVersioned.ts#L86)* *__description__*: Returns the wrapped metadata as a V0 object @@ -107,7 +107,7 @@ getasV1(): [MetadataV1](_metadata_v1_index_.metadatav1.md) *Inherited from [MetadataVersioned](_metadata_metadataversioned_.metadataversioned.md).[asV1](_metadata_metadataversioned_.metadataversioned.md#asv1)* -*Defined in [Metadata/MetadataVersioned.ts:103](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/MetadataVersioned.ts#L103)* +*Defined in [Metadata/MetadataVersioned.ts:103](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/MetadataVersioned.ts#L103)* *__description__*: Returns the wrapped values as a V1 object @@ -122,7 +122,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -137,7 +137,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -152,7 +152,7 @@ getmagicNumber(): [MagicNumber](_metadata_magicnumber_.magicnumber.md) *Inherited from [MetadataVersioned](_metadata_metadataversioned_.metadataversioned.md).[magicNumber](_metadata_metadataversioned_.metadataversioned.md#magicnumber)* -*Defined in [Metadata/MetadataVersioned.ts:65](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/MetadataVersioned.ts#L65)* +*Defined in [Metadata/MetadataVersioned.ts:65](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/MetadataVersioned.ts#L65)* *__description__*: @@ -167,7 +167,7 @@ getversion(): `number` *Inherited from [MetadataVersioned](_metadata_metadataversioned_.metadataversioned.md).[version](_metadata_metadataversioned_.metadataversioned.md#version)* -*Defined in [Metadata/MetadataVersioned.ts:79](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/MetadataVersioned.ts#L79)* +*Defined in [Metadata/MetadataVersioned.ts:79](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/MetadataVersioned.ts#L79)* *__description__*: the metadata version this structure represents @@ -249,7 +249,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -292,7 +292,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -313,7 +313,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -336,7 +336,7 @@ ___ *Inherited from [MetadataVersioned](_metadata_metadataversioned_.metadataversioned.md).[getUniqTypes](_metadata_metadataversioned_.metadataversioned.md#getuniqtypes)* -*Defined in [Metadata/MetadataVersioned.ts:109](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/MetadataVersioned.ts#L109)* +*Defined in [Metadata/MetadataVersioned.ts:109](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/MetadataVersioned.ts#L109)* **Returns:** `Array`<`string`> @@ -403,7 +403,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -420,7 +420,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -437,7 +437,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -454,7 +454,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -471,7 +471,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -507,7 +507,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_metadata_magicnumber_.magicnumber.md b/docs/types/classes/_metadata_magicnumber_.magicnumber.md index 4a95535cda..612dc293b4 100644 --- a/docs/types/classes/_metadata_magicnumber_.magicnumber.md +++ b/docs/types/classes/_metadata_magicnumber_.magicnumber.md @@ -20,7 +20,7 @@ *Overrides [U32](_primitive_u32_.u32.md).[constructor](_primitive_u32_.u32.md#constructor)* -*Defined in [Metadata/MagicNumber.ts:11](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/MagicNumber.ts#L11)* +*Defined in [Metadata/MagicNumber.ts:11](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/MagicNumber.ts#L11)* **Parameters:** @@ -42,7 +42,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -57,7 +57,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -197,7 +197,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -372,7 +372,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1536,7 +1536,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1577,7 +1577,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1596,7 +1596,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1649,7 +1649,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1695,7 +1695,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1899,7 +1899,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_metadata_metadataversioned_.metadataversioned.md b/docs/types/classes/_metadata_metadataversioned_.metadataversioned.md index 87760cd5c0..e3306f3df3 100644 --- a/docs/types/classes/_metadata_metadataversioned_.metadataversioned.md +++ b/docs/types/classes/_metadata_metadataversioned_.metadataversioned.md @@ -32,7 +32,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/MetadataVersioned.ts:53](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/MetadataVersioned.ts#L53)* +*Defined in [Metadata/MetadataVersioned.ts:53](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/MetadataVersioned.ts#L53)* **Parameters:** @@ -79,7 +79,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -92,7 +92,7 @@ ___ getasV0(): [MetadataV0](_metadata_v0_index_.metadatav0.md) -*Defined in [Metadata/MetadataVersioned.ts:86](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/MetadataVersioned.ts#L86)* +*Defined in [Metadata/MetadataVersioned.ts:86](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/MetadataVersioned.ts#L86)* *__description__*: Returns the wrapped metadata as a V0 object @@ -105,7 +105,7 @@ ___ getasV1(): [MetadataV1](_metadata_v1_index_.metadatav1.md) -*Defined in [Metadata/MetadataVersioned.ts:103](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/MetadataVersioned.ts#L103)* +*Defined in [Metadata/MetadataVersioned.ts:103](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/MetadataVersioned.ts#L103)* *__description__*: Returns the wrapped values as a V1 object @@ -120,7 +120,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -135,7 +135,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -148,7 +148,7 @@ ___ getmagicNumber(): [MagicNumber](_metadata_magicnumber_.magicnumber.md) -*Defined in [Metadata/MetadataVersioned.ts:65](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/MetadataVersioned.ts#L65)* +*Defined in [Metadata/MetadataVersioned.ts:65](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/MetadataVersioned.ts#L65)* *__description__*: @@ -161,7 +161,7 @@ ___ getversion(): `number` -*Defined in [Metadata/MetadataVersioned.ts:79](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/MetadataVersioned.ts#L79)* +*Defined in [Metadata/MetadataVersioned.ts:79](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/MetadataVersioned.ts#L79)* *__description__*: the metadata version this structure represents @@ -243,7 +243,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -286,7 +286,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -307,7 +307,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -328,7 +328,7 @@ ___ *Implementation of [MetadataInterface](../interfaces/_metadata_types_.metadatainterface.md).[getUniqTypes](../interfaces/_metadata_types_.metadatainterface.md#getuniqtypes)* -*Defined in [Metadata/MetadataVersioned.ts:109](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/MetadataVersioned.ts#L109)* +*Defined in [Metadata/MetadataVersioned.ts:109](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/MetadataVersioned.ts#L109)* **Returns:** `Array`<`string`> @@ -395,7 +395,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -412,7 +412,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -429,7 +429,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -446,7 +446,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -463,7 +463,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -499,7 +499,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_calls_.outerdispatchcall.md b/docs/types/classes/_metadata_v0_calls_.outerdispatchcall.md index df6a7a4fa1..973ee3096f 100644 --- a/docs/types/classes/_metadata_v0_calls_.outerdispatchcall.md +++ b/docs/types/classes/_metadata_v0_calls_.outerdispatchcall.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Calls.ts:10](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Calls.ts#L10)* +*Defined in [Metadata/v0/Calls.ts:10](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Calls.ts#L10)* **Parameters:** @@ -72,7 +72,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -87,7 +87,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -100,7 +100,7 @@ ___ getindex(): [U16](_primitive_u16_.u16.md) -*Defined in [Metadata/v0/Calls.ts:22](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Calls.ts#L22)* +*Defined in [Metadata/v0/Calls.ts:22](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Calls.ts#L22)* *__description__*: The [U16](_primitive_u16_.u16.md) index for the call @@ -115,7 +115,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -128,7 +128,7 @@ ___ getname(): [Text](_primitive_text_.text.md) -*Defined in [Metadata/v0/Calls.ts:29](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Calls.ts#L29)* +*Defined in [Metadata/v0/Calls.ts:29](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Calls.ts#L29)* *__description__*: The name for the call @@ -141,7 +141,7 @@ ___ getprefix(): [Text](_primitive_text_.text.md) -*Defined in [Metadata/v0/Calls.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Calls.ts#L36)* +*Defined in [Metadata/v0/Calls.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Calls.ts#L36)* *__description__*: The call prefix (or section) @@ -223,7 +223,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -266,7 +266,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -287,7 +287,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -362,7 +362,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -379,7 +379,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -396,7 +396,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -413,7 +413,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -430,7 +430,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -466,7 +466,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_calls_.outerdispatchmetadata.md b/docs/types/classes/_metadata_v0_calls_.outerdispatchmetadata.md index e5a7b15ffd..79e3dedb4b 100644 --- a/docs/types/classes/_metadata_v0_calls_.outerdispatchmetadata.md +++ b/docs/types/classes/_metadata_v0_calls_.outerdispatchmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Calls.ts:41](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Calls.ts#L41)* +*Defined in [Metadata/v0/Calls.ts:41](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Calls.ts#L41)* **Parameters:** @@ -72,7 +72,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -85,7 +85,7 @@ ___ getcalls(): [Vector](_codec_vector_.vector.md)<[OuterDispatchCall](_metadata_v0_calls_.outerdispatchcall.md)> -*Defined in [Metadata/v0/Calls.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Calls.ts#L52)* +*Defined in [Metadata/v0/Calls.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Calls.ts#L52)* *__description__*: The \[\[OuterDispathCall\]\] wrapped @@ -100,7 +100,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -115,7 +115,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -128,7 +128,7 @@ ___ getname(): [Text](_primitive_text_.text.md) -*Defined in [Metadata/v0/Calls.ts:59](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Calls.ts#L59)* +*Defined in [Metadata/v0/Calls.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Calls.ts#L59)* *__description__*: The name for the dispatch @@ -210,7 +210,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -253,7 +253,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -274,7 +274,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -383,7 +383,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -400,7 +400,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -417,7 +417,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -453,7 +453,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_events_.eventmetadata.md b/docs/types/classes/_metadata_v0_events_.eventmetadata.md index ae3309c26d..afb83e9541 100644 --- a/docs/types/classes/_metadata_v0_events_.eventmetadata.md +++ b/docs/types/classes/_metadata_v0_events_.eventmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Events.ts:11](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Events.ts#L11)* +*Defined in [Metadata/v0/Events.ts:11](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Events.ts#L11)* **Parameters:** @@ -72,7 +72,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -85,7 +85,7 @@ ___ getarguments(): [Vector](_codec_vector_.vector.md)<[Type](_primitive_type_.type.md)> -*Defined in [Metadata/v0/Events.ts:23](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Events.ts#L23)* +*Defined in [Metadata/v0/Events.ts:23](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Events.ts#L23)* *__description__*: The arguments of [Type](_metadata_v0_events_.eventmetadata.md#type) @@ -98,7 +98,7 @@ ___ getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_primitive_text_.text.md)> -*Defined in [Metadata/v0/Events.ts:30](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Events.ts#L30)* +*Defined in [Metadata/v0/Events.ts:30](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Events.ts#L30)* *__description__*: The [Text](_primitive_text_.text.md) documentation @@ -113,7 +113,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -128,7 +128,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -141,7 +141,7 @@ ___ getname(): [Text](_primitive_text_.text.md) -*Defined in [Metadata/v0/Events.ts:37](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Events.ts#L37)* +*Defined in [Metadata/v0/Events.ts:37](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Events.ts#L37)* *__description__*: The name for the event @@ -223,7 +223,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -266,7 +266,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -287,7 +287,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -362,7 +362,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -379,7 +379,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -396,7 +396,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -413,7 +413,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -430,7 +430,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -466,7 +466,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_events_.outereventmetadata.md b/docs/types/classes/_metadata_v0_events_.outereventmetadata.md index 5b127ee5ec..d390285084 100644 --- a/docs/types/classes/_metadata_v0_events_.outereventmetadata.md +++ b/docs/types/classes/_metadata_v0_events_.outereventmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Events.ts:65](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Events.ts#L65)* +*Defined in [Metadata/v0/Events.ts:65](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Events.ts#L65)* **Parameters:** @@ -72,7 +72,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -87,7 +87,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -100,7 +100,7 @@ ___ getevents(): [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_v0_events_.outereventmetadataevent.md)> -*Defined in [Metadata/v0/Events.ts:76](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Events.ts#L76)* +*Defined in [Metadata/v0/Events.ts:76](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Events.ts#L76)* *__description__*: The [OuterEventMetadataEvent](_metadata_v0_events_.outereventmetadataevent.md) @@ -115,7 +115,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -128,7 +128,7 @@ ___ getname(): [Text](_primitive_text_.text.md) -*Defined in [Metadata/v0/Events.ts:83](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Events.ts#L83)* +*Defined in [Metadata/v0/Events.ts:83](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Events.ts#L83)* *__description__*: The name of the event @@ -210,7 +210,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -253,7 +253,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -274,7 +274,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -383,7 +383,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -400,7 +400,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -417,7 +417,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -453,7 +453,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_events_.outereventmetadataevent.md b/docs/types/classes/_metadata_v0_events_.outereventmetadataevent.md index e33a2b3172..20c09ddd1b 100644 --- a/docs/types/classes/_metadata_v0_events_.outereventmetadataevent.md +++ b/docs/types/classes/_metadata_v0_events_.outereventmetadataevent.md @@ -23,7 +23,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [Metadata/v0/Events.ts:42](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Events.ts#L42)* +*Defined in [Metadata/v0/Events.ts:42](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Events.ts#L42)* **Parameters:** @@ -61,7 +61,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L75)* +*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L75)* *__description__*: The types definition of the tuple @@ -76,7 +76,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/1c6a89b/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -89,7 +89,7 @@ ___ getevents(): [Vector](_codec_vector_.vector.md)<[EventMetadata](_metadata_v0_events_.eventmetadata.md)> -*Defined in [Metadata/v0/Events.ts:53](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Events.ts#L53)* +*Defined in [Metadata/v0/Events.ts:53](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Events.ts#L53)* *__description__*: The [EventMetadata](_metadata_v0_events_.eventmetadata.md) @@ -104,7 +104,7 @@ getisEmpty(): `boolean` *Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L68)* *__description__*: Checks if the value is an empty value @@ -117,7 +117,7 @@ ___ getname(): [Text](_primitive_text_.text.md) -*Defined in [Metadata/v0/Events.ts:60](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Events.ts#L60)* +*Defined in [Metadata/v0/Events.ts:60](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Events.ts#L60)* *__description__*: The name of the section @@ -242,7 +242,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Compares the value of the input to see if there is a match @@ -310,7 +310,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L140)* +*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L140)* *__description__*: Filters the array with the callback @@ -730,7 +730,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L149)* +*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L149)* *__description__*: Maps the array with the callback @@ -1038,7 +1038,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1055,7 +1055,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Returns a hex string representation of the value @@ -1072,7 +1072,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L105)* +*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L105)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1106,7 +1106,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L114)* +*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L114)* *__description__*: Returns the string representation of the value @@ -1123,7 +1123,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L123)* +*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L123)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1180,7 +1180,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/1c6a89b/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_metadata_v0_index_.metadatav0.md b/docs/types/classes/_metadata_v0_index_.metadatav0.md index b727448505..0f8d6fcaab 100644 --- a/docs/types/classes/_metadata_v0_index_.metadatav0.md +++ b/docs/types/classes/_metadata_v0_index_.metadatav0.md @@ -30,7 +30,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/index.ts:26](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/index.ts#L26)* +*Defined in [Metadata/v0/index.ts:26](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/index.ts#L26)* **Parameters:** @@ -77,7 +77,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -90,7 +90,7 @@ ___ getcalls(): [Vector](_codec_vector_.vector.md)<[OuterDispatchCall](_metadata_v0_calls_.outerdispatchcall.md)> -*Defined in [Metadata/v0/index.ts:60](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/index.ts#L60)* +*Defined in [Metadata/v0/index.ts:60](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/index.ts#L60)* *__description__*: Wrapped [OuterDispatchCall](_metadata_v0_calls_.outerdispatchcall.md) @@ -105,7 +105,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -118,7 +118,7 @@ ___ getevents(): [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_v0_events_.outereventmetadataevent.md)> -*Defined in [Metadata/v0/index.ts:67](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/index.ts#L67)* +*Defined in [Metadata/v0/index.ts:67](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/index.ts#L67)* *__description__*: Wrapped [OuterEventMetadataEvent](_metadata_v0_events_.outereventmetadataevent.md) @@ -133,7 +133,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -146,7 +146,7 @@ ___ getmodules(): [Vector](_codec_vector_.vector.md)<[RuntimeModuleMetadata](_metadata_v0_modules_.runtimemodulemetadata.md)> -*Defined in [Metadata/v0/index.ts:74](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/index.ts#L74)* +*Defined in [Metadata/v0/index.ts:74](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/index.ts#L74)* *__description__*: Wrapped [RuntimeModuleMetadata](_metadata_v0_modules_.runtimemodulemetadata.md) @@ -228,7 +228,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -271,7 +271,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -292,7 +292,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -313,7 +313,7 @@ ___ *Implementation of [MetadataInterface](../interfaces/_metadata_types_.metadatainterface.md).[getUniqTypes](../interfaces/_metadata_types_.metadatainterface.md#getuniqtypes)* -*Defined in [Metadata/v0/index.ts:109](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/index.ts#L109)* +*Defined in [Metadata/v0/index.ts:109](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/index.ts#L109)* *__description__*: Helper to retrieve a list of all type that are found, sorted and de-deuplicated @@ -382,7 +382,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -399,7 +399,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -416,7 +416,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -433,7 +433,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -450,7 +450,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -484,7 +484,7 @@ ___ ▸ **decodeMetadata**(value: *`string` \| `Uint8Array` \| `object`*): `object` \| `Uint8Array` -*Defined in [Metadata/v0/index.ts:35](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/index.ts#L35)* +*Defined in [Metadata/v0/index.ts:35](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/index.ts#L35)* **Parameters:** @@ -503,7 +503,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_modules_.callmetadata.md b/docs/types/classes/_metadata_v0_modules_.callmetadata.md index 9392a93613..d4480f780f 100644 --- a/docs/types/classes/_metadata_v0_modules_.callmetadata.md +++ b/docs/types/classes/_metadata_v0_modules_.callmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Modules.ts:79](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L79)* +*Defined in [Metadata/v0/Modules.ts:79](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L79)* **Parameters:** @@ -72,7 +72,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -87,7 +87,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -100,7 +100,7 @@ ___ getfunctions(): [Vector](_codec_vector_.vector.md)<[FunctionMetadata](_metadata_v0_modules_.functionmetadata.md)> -*Defined in [Metadata/v0/Modules.ts:90](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L90)* +*Defined in [Metadata/v0/Modules.ts:90](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L90)* *__description__*: The functions available as [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) @@ -115,7 +115,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -128,7 +128,7 @@ ___ getname(): [Text](_primitive_text_.text.md) -*Defined in [Metadata/v0/Modules.ts:97](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L97)* +*Defined in [Metadata/v0/Modules.ts:97](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L97)* *__description__*: The section name @@ -210,7 +210,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -253,7 +253,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -274,7 +274,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -383,7 +383,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -400,7 +400,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -417,7 +417,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -453,7 +453,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_modules_.functionargumentmetadata.md b/docs/types/classes/_metadata_v0_modules_.functionargumentmetadata.md index 6e3357eea9..1516484b6e 100644 --- a/docs/types/classes/_metadata_v0_modules_.functionargumentmetadata.md +++ b/docs/types/classes/_metadata_v0_modules_.functionargumentmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Modules.ts:17](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L17)* +*Defined in [Metadata/v0/Modules.ts:17](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L17)* **Parameters:** @@ -72,7 +72,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -87,7 +87,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -102,7 +102,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -115,7 +115,7 @@ ___ getname(): [Text](_primitive_text_.text.md) -*Defined in [Metadata/v0/Modules.ts:28](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L28)* +*Defined in [Metadata/v0/Modules.ts:28](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L28)* *__description__*: The argument name @@ -128,7 +128,7 @@ ___ gettype(): [Type](_primitive_type_.type.md) -*Defined in [Metadata/v0/Modules.ts:35](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L35)* +*Defined in [Metadata/v0/Modules.ts:35](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L35)* *__description__*: The [Type](_metadata_v0_modules_.functionargumentmetadata.md#type) @@ -210,7 +210,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -253,7 +253,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -274,7 +274,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -383,7 +383,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -400,7 +400,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -417,7 +417,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -453,7 +453,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_modules_.functionmetadata.md b/docs/types/classes/_metadata_v0_modules_.functionmetadata.md index 717afb70d4..78e8818694 100644 --- a/docs/types/classes/_metadata_v0_modules_.functionmetadata.md +++ b/docs/types/classes/_metadata_v0_modules_.functionmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Modules.ts:40](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L40)* +*Defined in [Metadata/v0/Modules.ts:40](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L40)* **Parameters:** @@ -72,7 +72,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -85,7 +85,7 @@ ___ getarguments(): [Vector](_codec_vector_.vector.md)<[FunctionArgumentMetadata](_metadata_v0_modules_.functionargumentmetadata.md)> -*Defined in [Metadata/v0/Modules.ts:53](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L53)* +*Defined in [Metadata/v0/Modules.ts:53](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L53)* *__description__*: The [FunctionArgumentMetadata](_metadata_v0_modules_.functionargumentmetadata.md) for arguments @@ -98,7 +98,7 @@ ___ getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_primitive_text_.text.md)> -*Defined in [Metadata/v0/Modules.ts:60](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L60)* +*Defined in [Metadata/v0/Modules.ts:60](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L60)* *__description__*: The [Text](_primitive_text_.text.md) documentation @@ -113,7 +113,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -126,7 +126,7 @@ ___ getid(): [U16](_primitive_u16_.u16.md) -*Defined in [Metadata/v0/Modules.ts:67](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L67)* +*Defined in [Metadata/v0/Modules.ts:67](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L67)* *__description__*: The `[sectionIndex, methodIndex]` call id @@ -141,7 +141,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -154,7 +154,7 @@ ___ getname(): [Text](_primitive_text_.text.md) -*Defined in [Metadata/v0/Modules.ts:74](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L74)* +*Defined in [Metadata/v0/Modules.ts:74](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L74)* *__description__*: The call name @@ -236,7 +236,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -279,7 +279,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -300,7 +300,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -375,7 +375,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -392,7 +392,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -409,7 +409,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -426,7 +426,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -443,7 +443,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -479,7 +479,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_modules_.maptype.md b/docs/types/classes/_metadata_v0_modules_.maptype.md index d8e8b9bd60..9e9a477074 100644 --- a/docs/types/classes/_metadata_v0_modules_.maptype.md +++ b/docs/types/classes/_metadata_v0_modules_.maptype.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Modules.ts:138](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L138)* +*Defined in [Metadata/v0/Modules.ts:138](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L138)* **Parameters:** @@ -72,7 +72,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -87,7 +87,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -102,7 +102,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -115,7 +115,7 @@ ___ getkey(): [Type](_primitive_type_.type.md) -*Defined in [Metadata/v0/Modules.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L149)* +*Defined in [Metadata/v0/Modules.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L149)* *__description__*: The mapped key as [Type](_metadata_v0_modules_.maptype.md#type) @@ -128,7 +128,7 @@ ___ getvalue(): [Type](_primitive_type_.type.md) -*Defined in [Metadata/v0/Modules.ts:156](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L156)* +*Defined in [Metadata/v0/Modules.ts:156](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L156)* *__description__*: The mapped value as [Type](_metadata_v0_modules_.maptype.md#type) @@ -210,7 +210,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -253,7 +253,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -274,7 +274,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -383,7 +383,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -400,7 +400,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -417,7 +417,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -453,7 +453,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_modules_.modulemetadata.md b/docs/types/classes/_metadata_v0_modules_.modulemetadata.md index e119382a1a..ddcba6ee9e 100644 --- a/docs/types/classes/_metadata_v0_modules_.modulemetadata.md +++ b/docs/types/classes/_metadata_v0_modules_.modulemetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Modules.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L102)* +*Defined in [Metadata/v0/Modules.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L102)* **Parameters:** @@ -72,7 +72,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -85,7 +85,7 @@ ___ getcall(): [CallMetadata](_metadata_v0_modules_.callmetadata.md) -*Defined in [Metadata/v0/Modules.ts:113](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L113)* +*Defined in [Metadata/v0/Modules.ts:113](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L113)* *__description__*: The calls as [CallMetadata](_metadata_v0_modules_.callmetadata.md) @@ -100,7 +100,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -115,7 +115,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -128,7 +128,7 @@ ___ getname(): [Text](_primitive_text_.text.md) -*Defined in [Metadata/v0/Modules.ts:120](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L120)* +*Defined in [Metadata/v0/Modules.ts:120](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L120)* *__description__*: The name @@ -210,7 +210,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -253,7 +253,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -274,7 +274,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -383,7 +383,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -400,7 +400,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -417,7 +417,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -453,7 +453,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_modules_.runtimemodulemetadata.md b/docs/types/classes/_metadata_v0_modules_.runtimemodulemetadata.md index 1914e49402..9b7739081c 100644 --- a/docs/types/classes/_metadata_v0_modules_.runtimemodulemetadata.md +++ b/docs/types/classes/_metadata_v0_modules_.runtimemodulemetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Modules.ts:281](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L281)* +*Defined in [Metadata/v0/Modules.ts:281](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L281)* **Parameters:** @@ -72,7 +72,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -87,7 +87,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -102,7 +102,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -115,7 +115,7 @@ ___ getmodule(): [ModuleMetadata](_metadata_v0_modules_.modulemetadata.md) -*Defined in [Metadata/v0/Modules.ts:293](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L293)* +*Defined in [Metadata/v0/Modules.ts:293](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L293)* *__description__*: The [ModuleMetadata](_metadata_v0_modules_.modulemetadata.md) @@ -128,7 +128,7 @@ ___ getprefix(): [Text](_primitive_text_.text.md) -*Defined in [Metadata/v0/Modules.ts:300](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L300)* +*Defined in [Metadata/v0/Modules.ts:300](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L300)* *__description__*: The prefix @@ -141,7 +141,7 @@ ___ getstorage(): [Option](_codec_option_.option.md)<[StorageMetadata](_metadata_v0_modules_.storagemetadata.md)> -*Defined in [Metadata/v0/Modules.ts:307](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L307)* +*Defined in [Metadata/v0/Modules.ts:307](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L307)* *__description__*: The optional [StorageMetadata](_metadata_v0_modules_.storagemetadata.md) @@ -223,7 +223,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -266,7 +266,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -287,7 +287,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -362,7 +362,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -379,7 +379,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -396,7 +396,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -413,7 +413,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -430,7 +430,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -466,7 +466,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_modules_.storagefunctionmetadata.md b/docs/types/classes/_metadata_v0_modules_.storagefunctionmetadata.md index f8e28a4219..785416eab0 100644 --- a/docs/types/classes/_metadata_v0_modules_.storagefunctionmetadata.md +++ b/docs/types/classes/_metadata_v0_modules_.storagefunctionmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Modules.ts:211](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L211)* +*Defined in [Metadata/v0/Modules.ts:211](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L211)* **Parameters:** @@ -72,7 +72,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -85,7 +85,7 @@ ___ getdefault(): [Bytes](_primitive_bytes_.bytes.md) -*Defined in [Metadata/v0/Modules.ts:225](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L225)* +*Defined in [Metadata/v0/Modules.ts:225](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L225)* *__description__*: The default value of the storage function @@ -98,7 +98,7 @@ ___ getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_primitive_text_.text.md)> -*Defined in [Metadata/v0/Modules.ts:232](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L232)* +*Defined in [Metadata/v0/Modules.ts:232](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L232)* *__description__*: The [Text](_primitive_text_.text.md) documentation @@ -113,7 +113,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -128,7 +128,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -141,7 +141,7 @@ ___ getmodifier(): [StorageFunctionModifier](_metadata_v0_modules_.storagefunctionmodifier.md) -*Defined in [Metadata/v0/Modules.ts:246](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L246)* +*Defined in [Metadata/v0/Modules.ts:246](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L246)* *__description__*: The modifier @@ -154,7 +154,7 @@ ___ getname(): [Text](_primitive_text_.text.md) -*Defined in [Metadata/v0/Modules.ts:239](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L239)* +*Defined in [Metadata/v0/Modules.ts:239](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L239)* *__description__*: The key name @@ -167,7 +167,7 @@ ___ gettype(): [StorageFunctionType](_metadata_v0_modules_.storagefunctiontype.md) -*Defined in [Metadata/v0/Modules.ts:253](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L253)* +*Defined in [Metadata/v0/Modules.ts:253](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L253)* *__description__*: The [StorageFunctionType](_metadata_v0_modules_.storagefunctiontype.md) @@ -249,7 +249,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -292,7 +292,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -313,7 +313,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -388,7 +388,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -405,7 +405,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -422,7 +422,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -439,7 +439,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -456,7 +456,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -492,7 +492,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_modules_.storagefunctionmodifier.md b/docs/types/classes/_metadata_v0_modules_.storagefunctionmodifier.md index 44a43e4f2e..6e0c2be96e 100644 --- a/docs/types/classes/_metadata_v0_modules_.storagefunctionmodifier.md +++ b/docs/types/classes/_metadata_v0_modules_.storagefunctionmodifier.md @@ -20,7 +20,7 @@ *Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* -*Defined in [Metadata/v0/Modules.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L125)* +*Defined in [Metadata/v0/Modules.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/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/1c6a89b/packages/types/src/codec/Enum.ts#L64)* +*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -57,7 +57,7 @@ getisEmpty(): `boolean` *Inherited from [Enum](_codec_enum_.enum.md).[isEmpty](_codec_enum_.enum.md#isempty)* -*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L71)* +*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L71)* *__description__*: Checks if the value is an empty value (always false) @@ -70,7 +70,7 @@ ___ getisOptional(): `boolean` -*Defined in [Metadata/v0/Modules.ts:133](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L133)* +*Defined in [Metadata/v0/Modules.ts:133](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L133)* *__description__*: `true` if the storage entry is optional @@ -90,7 +90,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[eq](_codec_enum_.enum.md#eq)* -*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L78)* +*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L78)* *__description__*: Compares the value of the input to see if there is a match @@ -113,7 +113,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toHex](_codec_enum_.enum.md#tohex)* -*Defined in [codec/Enum.ts:91](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L91)* +*Defined in [codec/Enum.ts:91](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L91)* *__description__*: Returns a hex string representation of the value @@ -130,7 +130,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toJSON](_codec_enum_.enum.md#tojson)* -*Defined in [codec/Enum.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L98)* +*Defined in [codec/Enum.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L98)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -145,7 +145,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* -*Defined in [codec/Enum.ts:105](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L105)* +*Defined in [codec/Enum.ts:105](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L105)* *__description__*: Returns the number representation for the value @@ -162,7 +162,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toString](_codec_enum_.enum.md#tostring)* -*Defined in [codec/Enum.ts:112](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L112)* +*Defined in [codec/Enum.ts:112](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L112)* *__description__*: Returns the string representation of the value @@ -179,7 +179,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toU8a](_codec_enum_.enum.md#tou8a)* -*Defined in [codec/Enum.ts:120](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L120)* +*Defined in [codec/Enum.ts:120](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L120)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -200,7 +200,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/1c6a89b/packages/types/src/codec/Enum.ts#L47)* +*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L47)* **Parameters:** diff --git a/docs/types/classes/_metadata_v0_modules_.storagefunctiontype.md b/docs/types/classes/_metadata_v0_modules_.storagefunctiontype.md index 96d8a3e9d0..3c526d491e 100644 --- a/docs/types/classes/_metadata_v0_modules_.storagefunctiontype.md +++ b/docs/types/classes/_metadata_v0_modules_.storagefunctiontype.md @@ -20,7 +20,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [Metadata/v0/Modules.ts:164](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L164)* +*Defined in [Metadata/v0/Modules.ts:164](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L164)* **Parameters:** @@ -41,7 +41,7 @@ ___ getasMap(): [MapType](_metadata_v0_modules_.maptype.md) -*Defined in [Metadata/v0/Modules.ts:182](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L182)* +*Defined in [Metadata/v0/Modules.ts:182](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L182)* *__description__*: The value as a mapped value @@ -54,7 +54,7 @@ ___ getasType(): `PlainType` -*Defined in [Metadata/v0/Modules.ts:189](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L189)* +*Defined in [Metadata/v0/Modules.ts:189](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L189)* *__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:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L114)* +*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L114)* *__description__*: The length of the value when encoded as a Uint8Array @@ -84,7 +84,7 @@ getindex(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L121)* +*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L121)* *__description__*: The index of the metadata value @@ -99,7 +99,7 @@ getisEmpty(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isEmpty](_codec_enumtype_.enumtype.md#isempty)* -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L128)* +*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L128)* *__description__*: Checks if the value is an empty value @@ -112,7 +112,7 @@ ___ getisMap(): `boolean` -*Defined in [Metadata/v0/Modules.ts:175](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L175)* +*Defined in [Metadata/v0/Modules.ts:175](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L175)* *__description__*: `true` if the storage entry is a map @@ -127,7 +127,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L135)* +*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L135)* *__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type @@ -142,7 +142,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L142)* +*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L142)* *__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type (deprecated, use isNone) @@ -157,7 +157,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L149)* +*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L149)* *__description__*: The name of the type this enum value represents @@ -172,7 +172,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:156](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L156)* +*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L156)* *__description__*: The value of the enum @@ -192,7 +192,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* -*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L163)* +*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L163)* *__description__*: Compares the value of the input to see if there is a match @@ -215,7 +215,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L176)* +*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L176)* *__description__*: Returns a hex string representation of the value @@ -232,7 +232,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L183)* +*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L183)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -247,7 +247,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L192)* +*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L192)* *__description__*: Returns the number representation for the value @@ -264,7 +264,7 @@ ___ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [Metadata/v0/Modules.ts:196](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L196)* +*Defined in [Metadata/v0/Modules.ts:196](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L196)* *__description__*: Returns the string representation of the value @@ -281,7 +281,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L209)* +*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -302,7 +302,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L101)* +*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L101)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v0_modules_.storagemetadata.md b/docs/types/classes/_metadata_v0_modules_.storagemetadata.md index ccbef2a375..1112d40f26 100644 --- a/docs/types/classes/_metadata_v0_modules_.storagemetadata.md +++ b/docs/types/classes/_metadata_v0_modules_.storagemetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v0/Modules.ts:258](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L258)* +*Defined in [Metadata/v0/Modules.ts:258](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L258)* **Parameters:** @@ -72,7 +72,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -87,7 +87,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -100,7 +100,7 @@ ___ getfunctions(): [Vector](_codec_vector_.vector.md)<[StorageFunctionMetadata](_metadata_v0_modules_.storagefunctionmetadata.md)> -*Defined in [Metadata/v0/Modules.ts:269](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L269)* +*Defined in [Metadata/v0/Modules.ts:269](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L269)* *__description__*: The [StorageFunctionMetadata](_metadata_v0_modules_.storagefunctionmetadata.md) for the section @@ -115,7 +115,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -128,7 +128,7 @@ ___ getprefix(): [Text](_primitive_text_.text.md) -*Defined in [Metadata/v0/Modules.ts:276](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v0/Modules.ts#L276)* +*Defined in [Metadata/v0/Modules.ts:276](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v0/Modules.ts#L276)* *__description__*: The section prefix @@ -210,7 +210,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -253,7 +253,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -274,7 +274,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -383,7 +383,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -400,7 +400,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -417,7 +417,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -453,7 +453,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v1_calls_.metadatacall.md b/docs/types/classes/_metadata_v1_calls_.metadatacall.md index fa39ea4246..676824b579 100644 --- a/docs/types/classes/_metadata_v1_calls_.metadatacall.md +++ b/docs/types/classes/_metadata_v1_calls_.metadatacall.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v1/Calls.ts:38](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Calls.ts#L38)* +*Defined in [Metadata/v1/Calls.ts:38](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Calls.ts#L38)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -89,7 +89,7 @@ ___ getargs(): [Vector](_codec_vector_.vector.md)<[MetadataCallArg](_metadata_v1_calls_.metadatacallarg.md)> -*Defined in [Metadata/v1/Calls.ts:53](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Calls.ts#L53)* +*Defined in [Metadata/v1/Calls.ts:53](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Calls.ts#L53)* *__description__*: The [MetadataCallArg](_metadata_v1_calls_.metadatacallarg.md) for arguments @@ -102,7 +102,7 @@ ___ getdocs(): [Vector](_codec_vector_.vector.md)<[Text](_primitive_text_.text.md)> -*Defined in [Metadata/v1/Calls.ts:60](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Calls.ts#L60)* +*Defined in [Metadata/v1/Calls.ts:60](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Calls.ts#L60)* *__description__*: The [Text](_primitive_text_.text.md) documentation @@ -117,7 +117,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -132,7 +132,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -145,7 +145,7 @@ ___ getname(): [Text](_primitive_text_.text.md) -*Defined in [Metadata/v1/Calls.ts:74](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Calls.ts#L74)* +*Defined in [Metadata/v1/Calls.ts:74](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Calls.ts#L74)* *__description__*: The call name @@ -227,7 +227,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -270,7 +270,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -291,7 +291,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -383,7 +383,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -400,7 +400,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -417,7 +417,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -434,7 +434,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -470,7 +470,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v1_calls_.metadatacallarg.md b/docs/types/classes/_metadata_v1_calls_.metadatacallarg.md index 6a01118494..1bed1ca4c4 100644 --- a/docs/types/classes/_metadata_v1_calls_.metadatacallarg.md +++ b/docs/types/classes/_metadata_v1_calls_.metadatacallarg.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v1/Calls.ts:10](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Calls.ts#L10)* +*Defined in [Metadata/v1/Calls.ts:10](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Calls.ts#L10)* **Parameters:** @@ -72,7 +72,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -87,7 +87,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -102,7 +102,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -115,7 +115,7 @@ ___ getname(): [Text](_primitive_text_.text.md) -*Defined in [Metadata/v1/Calls.ts:21](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Calls.ts#L21)* +*Defined in [Metadata/v1/Calls.ts:21](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Calls.ts#L21)* *__description__*: The argument name @@ -128,7 +128,7 @@ ___ gettype(): [Type](_primitive_type_.type.md) -*Defined in [Metadata/v1/Calls.ts:28](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Calls.ts#L28)* +*Defined in [Metadata/v1/Calls.ts:28](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Calls.ts#L28)* *__description__*: The [Type](_metadata_v1_calls_.metadatacallarg.md#type) @@ -210,7 +210,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -253,7 +253,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -274,7 +274,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -383,7 +383,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -400,7 +400,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -417,7 +417,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -453,7 +453,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v1_events_.metadataevent.md b/docs/types/classes/_metadata_v1_events_.metadataevent.md index 46d0985474..40bf4caed4 100644 --- a/docs/types/classes/_metadata_v1_events_.metadataevent.md +++ b/docs/types/classes/_metadata_v1_events_.metadataevent.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v1/Events.ts:15](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Events.ts#L15)* +*Defined in [Metadata/v1/Events.ts:15](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Events.ts#L15)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -89,7 +89,7 @@ ___ getargs(): [Vector](_codec_vector_.vector.md)<[Type](_primitive_type_.type.md)> -*Defined in [Metadata/v1/Events.ts:27](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Events.ts#L27)* +*Defined in [Metadata/v1/Events.ts:27](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Events.ts#L27)* *__description__*: The [Type](_metadata_v1_events_.metadataevent.md#type) for args @@ -102,7 +102,7 @@ ___ getdocs(): [Vector](_codec_vector_.vector.md)<[Text](_primitive_text_.text.md)> -*Defined in [Metadata/v1/Events.ts:34](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Events.ts#L34)* +*Defined in [Metadata/v1/Events.ts:34](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Events.ts#L34)* *__description__*: The [Text](_primitive_text_.text.md) documentation @@ -117,7 +117,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -132,7 +132,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -145,7 +145,7 @@ ___ getname(): [Text](_primitive_text_.text.md) -*Defined in [Metadata/v1/Events.ts:41](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Events.ts#L41)* +*Defined in [Metadata/v1/Events.ts:41](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Events.ts#L41)* *__description__*: The call name @@ -227,7 +227,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -270,7 +270,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -291,7 +291,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -383,7 +383,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -400,7 +400,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -417,7 +417,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -434,7 +434,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -470,7 +470,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v1_index_.metadatamodule.md b/docs/types/classes/_metadata_v1_index_.metadatamodule.md index a41ddf4c26..364966960b 100644 --- a/docs/types/classes/_metadata_v1_index_.metadatamodule.md +++ b/docs/types/classes/_metadata_v1_index_.metadatamodule.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v1/index.ts:22](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/index.ts#L22)* +*Defined in [Metadata/v1/index.ts:22](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/index.ts#L22)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -89,7 +89,7 @@ ___ getcalls(): [Option](_codec_option_.option.md)<[Vector](_codec_vector_.vector.md)<[MetadataCall](_metadata_v1_calls_.metadatacall.md)>> -*Defined in [Metadata/v1/index.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/index.ts#L36)* +*Defined in [Metadata/v1/index.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/index.ts#L36)* *__description__*: the module calls @@ -104,7 +104,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -117,7 +117,7 @@ ___ getevents(): [Option](_codec_option_.option.md)<[Vector](_codec_vector_.vector.md)<[MetadataEvent](_metadata_v1_events_.metadataevent.md)>> -*Defined in [Metadata/v1/index.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/index.ts#L43)* +*Defined in [Metadata/v1/index.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/index.ts#L43)* *__description__*: the module events @@ -132,7 +132,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -145,7 +145,7 @@ ___ getname(): [Text](_primitive_text_.text.md) -*Defined in [Metadata/v1/index.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/index.ts#L50)* +*Defined in [Metadata/v1/index.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/index.ts#L50)* *__description__*: the module name @@ -158,7 +158,7 @@ ___ getprefix(): [Text](_primitive_text_.text.md) -*Defined in [Metadata/v1/index.ts:57](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/index.ts#L57)* +*Defined in [Metadata/v1/index.ts:57](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/index.ts#L57)* *__description__*: the module prefix @@ -171,7 +171,7 @@ ___ getstorage(): [Option](_codec_option_.option.md)<[Vector](_codec_vector_.vector.md)<[MetadataStorage](_metadata_v1_storage_.metadatastorage.md)>> -*Defined in [Metadata/v1/index.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/index.ts#L64)* +*Defined in [Metadata/v1/index.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/index.ts#L64)* *__description__*: the associated module storage @@ -253,7 +253,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -296,7 +296,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -317,7 +317,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -392,7 +392,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -409,7 +409,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -426,7 +426,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -443,7 +443,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -460,7 +460,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -496,7 +496,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v1_index_.metadatav1.md b/docs/types/classes/_metadata_v1_index_.metadatav1.md index 9d49d06a35..8a165dace0 100644 --- a/docs/types/classes/_metadata_v1_index_.metadatav1.md +++ b/docs/types/classes/_metadata_v1_index_.metadatav1.md @@ -30,7 +30,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v1/index.ts:74](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/index.ts#L74)* +*Defined in [Metadata/v1/index.ts:74](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/index.ts#L74)* **Parameters:** @@ -77,7 +77,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -92,7 +92,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -107,7 +107,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -120,7 +120,7 @@ ___ getmodules(): [Vector](_codec_vector_.vector.md)<[MetadataModule](_metadata_v1_index_.metadatamodule.md)> -*Defined in [Metadata/v1/index.ts:84](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/index.ts#L84)* +*Defined in [Metadata/v1/index.ts:84](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/index.ts#L84)* *__description__*: The associated modules for this structure @@ -202,7 +202,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -245,7 +245,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -266,7 +266,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -287,7 +287,7 @@ ___ *Implementation of [MetadataInterface](../interfaces/_metadata_types_.metadatainterface.md).[getUniqTypes](../interfaces/_metadata_types_.metadatainterface.md#getuniqtypes)* -*Defined in [Metadata/v1/index.ts:123](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/index.ts#L123)* +*Defined in [Metadata/v1/index.ts:123](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/index.ts#L123)* *__description__*: Helper to retrieve a list of all type that are found, sorted and de-deuplicated @@ -356,7 +356,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -373,7 +373,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -390,7 +390,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -407,7 +407,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -424,7 +424,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -460,7 +460,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v1_storage_.default.md b/docs/types/classes/_metadata_v1_storage_.default.md index 000b71599c..9223d7c700 100644 --- a/docs/types/classes/_metadata_v1_storage_.default.md +++ b/docs/types/classes/_metadata_v1_storage_.default.md @@ -20,7 +20,7 @@ getencodedLength(): `number` *Inherited from [Null](_primitive_null_.null.md).[encodedLength](_primitive_null_.null.md#encodedlength)* -*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L17)* +*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L17)* *__description__*: The length of the value when encoded as a Uint8Array @@ -35,7 +35,7 @@ getisEmpty(): `boolean` *Inherited from [Null](_primitive_null_.null.md).[isEmpty](_primitive_null_.null.md#isempty)* -*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L24)* +*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L24)* *__description__*: Checks if the value is an empty value (always true) @@ -55,7 +55,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[eq](_primitive_null_.null.md#eq)* -*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L31)* +*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L31)* *__description__*: Compares the value of the input to see if there is a match @@ -78,7 +78,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toHex](_primitive_null_.null.md#tohex)* -*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L38)* +*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L38)* *__description__*: Returns a hex string representation of the value @@ -95,7 +95,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toJSON](_primitive_null_.null.md#tojson)* -*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L45)* +*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L45)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -112,7 +112,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toString](_primitive_null_.null.md#tostring)* -*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L52)* +*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L52)* *__description__*: Returns the string representation of the value @@ -129,7 +129,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toU8a](_primitive_null_.null.md#tou8a)* -*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L60)* +*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L60)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_metadata_v1_storage_.maptype.md b/docs/types/classes/_metadata_v1_storage_.maptype.md index 77bf337319..7118b07e1b 100644 --- a/docs/types/classes/_metadata_v1_storage_.maptype.md +++ b/docs/types/classes/_metadata_v1_storage_.maptype.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v1/Storage.ts:37](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Storage.ts#L37)* +*Defined in [Metadata/v1/Storage.ts:37](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Storage.ts#L37)* **Parameters:** @@ -72,7 +72,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -87,7 +87,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -102,7 +102,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -115,7 +115,7 @@ ___ getkey(): [Type](_primitive_type_.type.md) -*Defined in [Metadata/v1/Storage.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Storage.ts#L48)* +*Defined in [Metadata/v1/Storage.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Storage.ts#L48)* *__description__*: The mapped key as [Type](_metadata_v1_storage_.maptype.md#type) @@ -128,7 +128,7 @@ ___ getvalue(): [Type](_primitive_type_.type.md) -*Defined in [Metadata/v1/Storage.ts:55](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Storage.ts#L55)* +*Defined in [Metadata/v1/Storage.ts:55](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Storage.ts#L55)* *__description__*: The mapped value as [Type](_metadata_v1_storage_.maptype.md#type) @@ -210,7 +210,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -253,7 +253,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -274,7 +274,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -383,7 +383,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -400,7 +400,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -417,7 +417,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -453,7 +453,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v1_storage_.metadatastorage.md b/docs/types/classes/_metadata_v1_storage_.metadatastorage.md index 7489f9891a..478da6fead 100644 --- a/docs/types/classes/_metadata_v1_storage_.metadatastorage.md +++ b/docs/types/classes/_metadata_v1_storage_.metadatastorage.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/v1/Storage.ts:107](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Storage.ts#L107)* +*Defined in [Metadata/v1/Storage.ts:107](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Storage.ts#L107)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -89,7 +89,7 @@ ___ getdocs(): [Vector](_codec_vector_.vector.md)<[Text](_primitive_text_.text.md)> -*Defined in [Metadata/v1/Storage.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Storage.ts#L121)* +*Defined in [Metadata/v1/Storage.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Storage.ts#L121)* *__description__*: The [Text](_primitive_text_.text.md) documentation @@ -104,7 +104,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -117,7 +117,7 @@ ___ getfallback(): [Bytes](_primitive_bytes_.bytes.md) -*Defined in [Metadata/v1/Storage.ts:128](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Storage.ts#L128)* +*Defined in [Metadata/v1/Storage.ts:128](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Storage.ts#L128)* *__description__*: The [Bytes](_primitive_bytes_.bytes.md) fallback default @@ -132,7 +132,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -145,7 +145,7 @@ ___ getmodifier(): [MetadataStorageModifier](_metadata_v1_storage_.metadatastoragemodifier.md) -*Defined in [Metadata/v1/Storage.ts:135](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Storage.ts#L135)* +*Defined in [Metadata/v1/Storage.ts:135](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Storage.ts#L135)* *__description__*: The \[\[MetadataArgument\]\] for arguments @@ -158,7 +158,7 @@ ___ getname(): [Text](_primitive_text_.text.md) -*Defined in [Metadata/v1/Storage.ts:142](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Storage.ts#L142)* +*Defined in [Metadata/v1/Storage.ts:142](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Storage.ts#L142)* *__description__*: The call name @@ -171,7 +171,7 @@ ___ gettype(): [MetadataStorageType](_metadata_v1_storage_.metadatastoragetype.md) -*Defined in [Metadata/v1/Storage.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Storage.ts#L149)* +*Defined in [Metadata/v1/Storage.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Storage.ts#L149)* *__description__*: The [MetadataStorageType](_metadata_v1_storage_.metadatastoragetype.md) @@ -253,7 +253,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -296,7 +296,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -317,7 +317,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -392,7 +392,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -409,7 +409,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -426,7 +426,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -443,7 +443,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -460,7 +460,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -496,7 +496,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v1_storage_.metadatastoragemodifier.md b/docs/types/classes/_metadata_v1_storage_.metadatastoragemodifier.md index a925e3a553..0840c03d4a 100644 --- a/docs/types/classes/_metadata_v1_storage_.metadatastoragemodifier.md +++ b/docs/types/classes/_metadata_v1_storage_.metadatastoragemodifier.md @@ -20,7 +20,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [Metadata/v1/Storage.ts:17](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Storage.ts#L17)* +*Defined in [Metadata/v1/Storage.ts:17](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Storage.ts#L17)* **Parameters:** @@ -43,7 +43,7 @@ getencodedLength(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L114)* +*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L114)* *__description__*: The length of the value when encoded as a Uint8Array @@ -58,7 +58,7 @@ getindex(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L121)* +*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L121)* *__description__*: The index of the metadata value @@ -73,7 +73,7 @@ getisEmpty(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isEmpty](_codec_enumtype_.enumtype.md#isempty)* -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L128)* +*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L128)* *__description__*: Checks if the value is an empty value @@ -88,7 +88,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L135)* +*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L135)* *__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type @@ -103,7 +103,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L142)* +*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L142)* *__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type (deprecated, use isNone) @@ -116,7 +116,7 @@ ___ getisOptional(): `boolean` -*Defined in [Metadata/v1/Storage.ts:28](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Storage.ts#L28)* +*Defined in [Metadata/v1/Storage.ts:28](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Storage.ts#L28)* *__description__*: `true` if the storage entry is optional @@ -131,7 +131,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L149)* +*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L149)* *__description__*: The name of the type this enum value represents @@ -146,7 +146,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:156](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L156)* +*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L156)* *__description__*: The value of the enum @@ -166,7 +166,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* -*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L163)* +*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L163)* *__description__*: Compares the value of the input to see if there is a match @@ -189,7 +189,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L176)* +*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L176)* *__description__*: Returns a hex string representation of the value @@ -206,7 +206,7 @@ ___ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [Metadata/v1/Storage.ts:32](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Storage.ts#L32)* +*Defined in [Metadata/v1/Storage.ts:32](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Storage.ts#L32)* **Returns:** `any` @@ -219,7 +219,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L192)* +*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L192)* *__description__*: Returns the number representation for the value @@ -236,7 +236,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [codec/EnumType.ts:199](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L199)* +*Defined in [codec/EnumType.ts:199](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L199)* *__description__*: Returns the string representation of the value @@ -253,7 +253,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L209)* +*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -274,7 +274,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L101)* +*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L101)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v1_storage_.metadatastoragetype.md b/docs/types/classes/_metadata_v1_storage_.metadatastoragetype.md index 03b2c5f95e..3bde320aed 100644 --- a/docs/types/classes/_metadata_v1_storage_.metadatastoragetype.md +++ b/docs/types/classes/_metadata_v1_storage_.metadatastoragetype.md @@ -20,7 +20,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [Metadata/v1/Storage.ts:63](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Storage.ts#L63)* +*Defined in [Metadata/v1/Storage.ts:63](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Storage.ts#L63)* **Parameters:** @@ -41,7 +41,7 @@ ___ getasMap(): [MapType](_metadata_v1_storage_.maptype.md) -*Defined in [Metadata/v1/Storage.ts:81](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Storage.ts#L81)* +*Defined in [Metadata/v1/Storage.ts:81](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Storage.ts#L81)* *__description__*: The value as a mapped value @@ -54,7 +54,7 @@ ___ getasType(): [PlainType](_metadata_v1_storage_.plaintype.md) -*Defined in [Metadata/v1/Storage.ts:88](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Storage.ts#L88)* +*Defined in [Metadata/v1/Storage.ts:88](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Storage.ts#L88)* *__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:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L114)* +*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L114)* *__description__*: The length of the value when encoded as a Uint8Array @@ -84,7 +84,7 @@ getindex(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L121)* +*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L121)* *__description__*: The index of the metadata value @@ -99,7 +99,7 @@ getisEmpty(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isEmpty](_codec_enumtype_.enumtype.md#isempty)* -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L128)* +*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L128)* *__description__*: Checks if the value is an empty value @@ -112,7 +112,7 @@ ___ getisMap(): `boolean` -*Defined in [Metadata/v1/Storage.ts:74](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Storage.ts#L74)* +*Defined in [Metadata/v1/Storage.ts:74](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Storage.ts#L74)* *__description__*: `true` if the storage entry is a map @@ -127,7 +127,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L135)* +*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L135)* *__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type @@ -142,7 +142,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L142)* +*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L142)* *__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type (deprecated, use isNone) @@ -157,7 +157,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L149)* +*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L149)* *__description__*: The name of the type this enum value represents @@ -172,7 +172,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:156](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L156)* +*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L156)* *__description__*: The value of the enum @@ -192,7 +192,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* -*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L163)* +*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L163)* *__description__*: Compares the value of the input to see if there is a match @@ -215,7 +215,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L176)* +*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L176)* *__description__*: Returns a hex string representation of the value @@ -232,7 +232,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L183)* +*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L183)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -247,7 +247,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L192)* +*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L192)* *__description__*: Returns the number representation for the value @@ -264,7 +264,7 @@ ___ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [Metadata/v1/Storage.ts:95](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/Storage.ts#L95)* +*Defined in [Metadata/v1/Storage.ts:95](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/Storage.ts#L95)* *__description__*: Returns the string representation of the value @@ -281,7 +281,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L209)* +*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -302,7 +302,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L101)* +*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L101)* **Type parameters:** diff --git a/docs/types/classes/_metadata_v1_storage_.optional.md b/docs/types/classes/_metadata_v1_storage_.optional.md index cd8e8559d8..d36f824502 100644 --- a/docs/types/classes/_metadata_v1_storage_.optional.md +++ b/docs/types/classes/_metadata_v1_storage_.optional.md @@ -20,7 +20,7 @@ getencodedLength(): `number` *Inherited from [Null](_primitive_null_.null.md).[encodedLength](_primitive_null_.null.md#encodedlength)* -*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L17)* +*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L17)* *__description__*: The length of the value when encoded as a Uint8Array @@ -35,7 +35,7 @@ getisEmpty(): `boolean` *Inherited from [Null](_primitive_null_.null.md).[isEmpty](_primitive_null_.null.md#isempty)* -*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L24)* +*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L24)* *__description__*: Checks if the value is an empty value (always true) @@ -55,7 +55,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[eq](_primitive_null_.null.md#eq)* -*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L31)* +*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L31)* *__description__*: Compares the value of the input to see if there is a match @@ -78,7 +78,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toHex](_primitive_null_.null.md#tohex)* -*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L38)* +*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L38)* *__description__*: Returns a hex string representation of the value @@ -95,7 +95,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toJSON](_primitive_null_.null.md#tojson)* -*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L45)* +*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L45)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -112,7 +112,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toString](_primitive_null_.null.md#tostring)* -*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L52)* +*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L52)* *__description__*: Returns the string representation of the value @@ -129,7 +129,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toU8a](_primitive_null_.null.md#tou8a)* -*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L60)* +*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L60)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_metadata_v1_storage_.plaintype.md b/docs/types/classes/_metadata_v1_storage_.plaintype.md index 4dff292ee0..ec9eeb53fe 100644 --- a/docs/types/classes/_metadata_v1_storage_.plaintype.md +++ b/docs/types/classes/_metadata_v1_storage_.plaintype.md @@ -25,7 +25,7 @@ *Overrides [Text](_primitive_text_.text.md).[constructor](_primitive_text_.text.md#constructor)* -*Defined in [primitive/Type.ts:19](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Type.ts#L19)* +*Defined in [primitive/Type.ts:19](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Type.ts#L19)* **Parameters:** @@ -49,7 +49,7 @@ getencodedLength(): `number` *Overrides [Text](_primitive_text_.text.md).[encodedLength](_primitive_text_.text.md#encodedlength)* -*Defined in [primitive/Type.ts:76](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Type.ts#L76)* +*Defined in [primitive/Type.ts:76](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Type.ts#L76)* *__description__*: The length of the value when encoded as a Uint8Array @@ -64,7 +64,7 @@ getisEmpty(): `boolean` *Inherited from [Text](_primitive_text_.text.md).[isEmpty](_primitive_text_.text.md#isempty)* -*Defined in [primitive/Text.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Text.ts#L52)* +*Defined in [primitive/Text.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Text.ts#L52)* *__description__*: Checks if the value is an empty value @@ -81,7 +81,7 @@ getlength(): `number` *Overrides String.length* -*Defined in [primitive/Text.ts:59](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Text.ts#L59)* +*Defined in [primitive/Text.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Text.ts#L59)* *__description__*: The length of the value @@ -288,7 +288,7 @@ ___ *Inherited from [Text](_primitive_text_.text.md).[eq](_primitive_text_.text.md#eq)* -*Defined in [primitive/Text.ts:67](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Text.ts#L67)* +*Defined in [primitive/Text.ts:67](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Text.ts#L67)* *__description__*: Compares the value of the input to see if there is a match @@ -870,7 +870,7 @@ ___ *Inherited from [Text](_primitive_text_.text.md).[toHex](_primitive_text_.text.md#tohex)* -*Defined in [primitive/Text.ts:76](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Text.ts#L76)* +*Defined in [primitive/Text.ts:76](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Text.ts#L76)* *__description__*: Returns a hex string representation of the value @@ -887,7 +887,7 @@ ___ *Inherited from [Text](_primitive_text_.text.md).[toJSON](_primitive_text_.text.md#tojson)* -*Defined in [primitive/Text.ts:83](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Text.ts#L83)* +*Defined in [primitive/Text.ts:83](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Text.ts#L83)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -951,7 +951,7 @@ ___ *Overrides String.toString* -*Defined in [primitive/Text.ts:90](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Text.ts#L90)* +*Defined in [primitive/Text.ts:90](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Text.ts#L90)* *__description__*: Returns the string representation of the value @@ -970,7 +970,7 @@ ___ *Overrides [Text](_primitive_text_.text.md).[toU8a](_primitive_text_.text.md#tou8a)* -*Defined in [primitive/Type.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Type.ts#L87)* +*Defined in [primitive/Type.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Type.ts#L87)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_primitive_bool_.bool.md b/docs/types/classes/_primitive_bool_.bool.md index 13d694fe5d..72968a0e58 100644 --- a/docs/types/classes/_primitive_bool_.bool.md +++ b/docs/types/classes/_primitive_bool_.bool.md @@ -22,7 +22,7 @@ ⊕ **new Bool**(value?: *[Bool](_primitive_bool_.bool.md) \| `Boolean` \| `Uint8Array` \| `boolean` \| `number`*): [Bool](_primitive_bool_.bool.md) -*Defined in [primitive/Bool.ts:15](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bool.ts#L15)* +*Defined in [primitive/Bool.ts:15](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bool.ts#L15)* **Parameters:** @@ -54,7 +54,7 @@ ___ getencodedLength(): `number` -*Defined in [primitive/Bool.ts:35](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bool.ts#L35)* +*Defined in [primitive/Bool.ts:35](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bool.ts#L35)* *__description__*: The length of the value when encoded as a Uint8Array @@ -67,7 +67,7 @@ ___ getisEmpty(): `boolean` -*Defined in [primitive/Bool.ts:42](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bool.ts#L42)* +*Defined in [primitive/Bool.ts:42](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bool.ts#L42)* *__description__*: Checks if the value is an empty value (always false) @@ -85,7 +85,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [primitive/Bool.ts:49](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bool.ts#L49)* +*Defined in [primitive/Bool.ts:49](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bool.ts#L49)* *__description__*: Compares the value of the input to see if there is a match @@ -106,7 +106,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [primitive/Bool.ts:60](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bool.ts#L60)* +*Defined in [primitive/Bool.ts:60](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bool.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -121,7 +121,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [primitive/Bool.ts:67](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bool.ts#L67)* +*Defined in [primitive/Bool.ts:67](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bool.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -136,7 +136,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [primitive/Bool.ts:74](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bool.ts#L74)* +*Defined in [primitive/Bool.ts:74](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bool.ts#L74)* *__description__*: Returns the string representation of the value @@ -151,7 +151,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [primitive/Bool.ts:82](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bool.ts#L82)* +*Defined in [primitive/Bool.ts:82](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bool.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_primitive_bytes_.bytes.md b/docs/types/classes/_primitive_bytes_.bytes.md index 358fb2a35b..13d0e251b6 100644 --- a/docs/types/classes/_primitive_bytes_.bytes.md +++ b/docs/types/classes/_primitive_bytes_.bytes.md @@ -37,7 +37,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [primitive/Bytes.ts:18](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bytes.ts#L18)* +*Defined in [primitive/Bytes.ts:18](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bytes.ts#L18)* **Parameters:** @@ -125,7 +125,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [primitive/Bytes.ts:61](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bytes.ts#L61)* +*Defined in [primitive/Bytes.ts:61](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bytes.ts#L61)* *__description__*: The length of the value when encoded as a Uint8Array @@ -140,7 +140,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -157,7 +157,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -228,7 +228,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -722,7 +722,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -746,7 +746,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -763,7 +763,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -797,7 +797,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -814,7 +814,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [primitive/Bytes.ts:69](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bytes.ts#L69)* +*Defined in [primitive/Bytes.ts:69](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bytes.ts#L69)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_primitive_data_.data.md b/docs/types/classes/_primitive_data_.data.md index f14fab078c..30cd0e94b7 100644 --- a/docs/types/classes/_primitive_data_.data.md +++ b/docs/types/classes/_primitive_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/1c6a89b/packages/types/src/codec/U8a.ts#L18)* +*Defined in [codec/U8a.ts:18](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L18)* **Parameters:** @@ -115,7 +115,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -130,7 +130,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -147,7 +147,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -218,7 +218,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -712,7 +712,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -736,7 +736,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -753,7 +753,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -787,7 +787,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -804,7 +804,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_primitive_h160_.h160.md b/docs/types/classes/_primitive_h160_.h160.md index 9c3de77ca7..c42e3b23ed 100644 --- a/docs/types/classes/_primitive_h160_.h160.md +++ b/docs/types/classes/_primitive_h160_.h160.md @@ -27,7 +27,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [primitive/H160.ts:15](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/H160.ts#L15)* +*Defined in [primitive/H160.ts:15](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/H160.ts#L15)* **Parameters:** @@ -115,7 +115,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -130,7 +130,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -147,7 +147,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -178,7 +178,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -233,7 +233,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -727,7 +727,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -751,7 +751,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -768,7 +768,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -802,7 +802,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -819,7 +819,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_primitive_h256_.h256.md b/docs/types/classes/_primitive_h256_.h256.md index 0a18e54eb7..5497e9515d 100644 --- a/docs/types/classes/_primitive_h256_.h256.md +++ b/docs/types/classes/_primitive_h256_.h256.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [primitive/H256.ts:15](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/H256.ts#L15)* +*Defined in [primitive/H256.ts:15](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/H256.ts#L15)* **Parameters:** @@ -117,7 +117,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -132,7 +132,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -149,7 +149,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -180,7 +180,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -235,7 +235,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -729,7 +729,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -753,7 +753,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -770,7 +770,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -804,7 +804,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -821,7 +821,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_primitive_h512_.h512.md b/docs/types/classes/_primitive_h512_.h512.md index 00ff1e960e..29e6966fe4 100644 --- a/docs/types/classes/_primitive_h512_.h512.md +++ b/docs/types/classes/_primitive_h512_.h512.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [primitive/H512.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/H512.ts#L14)* +*Defined in [primitive/H512.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/H512.ts#L14)* **Parameters:** @@ -117,7 +117,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -132,7 +132,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -149,7 +149,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -180,7 +180,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -235,7 +235,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -729,7 +729,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -753,7 +753,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -770,7 +770,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -804,7 +804,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -821,7 +821,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_primitive_i128_.i128.md b/docs/types/classes/_primitive_i128_.i128.md index e2c9caa91c..e3b219bb0f 100644 --- a/docs/types/classes/_primitive_i128_.i128.md +++ b/docs/types/classes/_primitive_i128_.i128.md @@ -24,7 +24,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [primitive/I128.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/I128.ts#L14)* +*Defined in [primitive/I128.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/I128.ts#L14)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -61,7 +61,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -201,7 +201,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -376,7 +376,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1540,7 +1540,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1581,7 +1581,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1600,7 +1600,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1653,7 +1653,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1699,7 +1699,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1903,7 +1903,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_primitive_i16_.i16.md b/docs/types/classes/_primitive_i16_.i16.md index 781092ab19..fa073b4454 100644 --- a/docs/types/classes/_primitive_i16_.i16.md +++ b/docs/types/classes/_primitive_i16_.i16.md @@ -24,7 +24,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [primitive/I16.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/I16.ts#L14)* +*Defined in [primitive/I16.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/I16.ts#L14)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -61,7 +61,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -201,7 +201,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -376,7 +376,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1540,7 +1540,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1581,7 +1581,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1600,7 +1600,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1653,7 +1653,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1699,7 +1699,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1903,7 +1903,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_primitive_i256_.i256.md b/docs/types/classes/_primitive_i256_.i256.md index b613d6198c..9b5a500299 100644 --- a/docs/types/classes/_primitive_i256_.i256.md +++ b/docs/types/classes/_primitive_i256_.i256.md @@ -24,7 +24,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [primitive/I256.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/I256.ts#L14)* +*Defined in [primitive/I256.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/I256.ts#L14)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -61,7 +61,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -201,7 +201,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -376,7 +376,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1540,7 +1540,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1581,7 +1581,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1600,7 +1600,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1653,7 +1653,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1699,7 +1699,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1903,7 +1903,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_primitive_i32_.i32.md b/docs/types/classes/_primitive_i32_.i32.md index 534142d4bf..94e6d74ef6 100644 --- a/docs/types/classes/_primitive_i32_.i32.md +++ b/docs/types/classes/_primitive_i32_.i32.md @@ -24,7 +24,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [primitive/I32.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/I32.ts#L14)* +*Defined in [primitive/I32.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/I32.ts#L14)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -61,7 +61,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -201,7 +201,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -376,7 +376,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1540,7 +1540,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1581,7 +1581,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1600,7 +1600,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1653,7 +1653,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1699,7 +1699,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1903,7 +1903,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_primitive_i64_.i64.md b/docs/types/classes/_primitive_i64_.i64.md index 2f39983d18..98f51d3050 100644 --- a/docs/types/classes/_primitive_i64_.i64.md +++ b/docs/types/classes/_primitive_i64_.i64.md @@ -24,7 +24,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [primitive/I64.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/I64.ts#L14)* +*Defined in [primitive/I64.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/I64.ts#L14)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -61,7 +61,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -201,7 +201,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -376,7 +376,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1540,7 +1540,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1581,7 +1581,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1600,7 +1600,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1653,7 +1653,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1699,7 +1699,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1903,7 +1903,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_primitive_i8_.i8.md b/docs/types/classes/_primitive_i8_.i8.md index e775784206..db99a7ae36 100644 --- a/docs/types/classes/_primitive_i8_.i8.md +++ b/docs/types/classes/_primitive_i8_.i8.md @@ -28,7 +28,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [primitive/I8.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/I8.ts#L14)* +*Defined in [primitive/I8.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/I8.ts#L14)* **Parameters:** @@ -50,7 +50,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -65,7 +65,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -205,7 +205,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -380,7 +380,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1544,7 +1544,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1585,7 +1585,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1604,7 +1604,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1657,7 +1657,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1703,7 +1703,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1907,7 +1907,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_primitive_method_.method.md b/docs/types/classes/_primitive_method_.method.md index 4dda405325..f0d5364dc3 100644 --- a/docs/types/classes/_primitive_method_.method.md +++ b/docs/types/classes/_primitive_method_.method.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [primitive/Method.ts:70](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L70)* +*Defined in [primitive/Method.ts:70](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L70)* **Parameters:** @@ -79,7 +79,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -92,7 +92,7 @@ ___ getargs(): `Array`<[Codec](../interfaces/_types_.codec.md)> -*Defined in [primitive/Method.ts:192](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L192)* +*Defined in [primitive/Method.ts:192](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L192)* *__description__*: The arguments for the function call @@ -105,7 +105,7 @@ ___ getargsDef(): `ArgsDef` -*Defined in [primitive/Method.ts:200](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L200)* +*Defined in [primitive/Method.ts:200](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L200)* *__description__*: Thge argument defintions @@ -118,7 +118,7 @@ ___ getcallIndex(): `Uint8Array` -*Defined in [primitive/Method.ts:207](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L207)* +*Defined in [primitive/Method.ts:207](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L207)* *__description__*: The encoded `[sectionIndex, methodIndex]` identifier @@ -131,7 +131,7 @@ ___ getdata(): `Uint8Array` -*Defined in [primitive/Method.ts:214](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L214)* +*Defined in [primitive/Method.ts:214](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L214)* *__description__*: The encoded data @@ -146,7 +146,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -159,7 +159,7 @@ ___ gethasOrigin(): `boolean` -*Defined in [primitive/Method.ts:221](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L221)* +*Defined in [primitive/Method.ts:221](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L221)* *__description__*: `true` if the `Origin` type is on the method (extrinsic method) @@ -174,7 +174,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -187,7 +187,7 @@ ___ getmeta(): [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) -*Defined in [primitive/Method.ts:230](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L230)* +*Defined in [primitive/Method.ts:230](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L230)* *__description__*: The [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) @@ -269,7 +269,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -312,7 +312,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -333,7 +333,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -408,7 +408,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -425,7 +425,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -442,7 +442,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -459,7 +459,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -476,7 +476,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -510,7 +510,7 @@ ___ ▸ **filterOrigin**(meta?: *[FunctionMetadata](_metadata_v0_modules_.functionmetadata.md)*): `Array`<[FunctionArgumentMetadata](_metadata_v0_modules_.functionargumentmetadata.md)> -*Defined in [primitive/Method.ts:140](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L140)* +*Defined in [primitive/Method.ts:140](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L140)* **Parameters:** @@ -527,7 +527,7 @@ ___ ▸ **findFunction**(callIndex: *`Uint8Array`*): [MethodFunction](../interfaces/_primitive_method_.methodfunction.md) -*Defined in [primitive/Method.ts:156](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L156)* +*Defined in [primitive/Method.ts:156](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L156)* **Parameters:** @@ -544,7 +544,7 @@ ___ ▸ **injectMethods**(moduleMethods: *[ModulesWithMethods](../interfaces/_primitive_method_.moduleswithmethods.md)*): `void` -*Defined in [primitive/Method.ts:181](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L181)* +*Defined in [primitive/Method.ts:181](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L181)* **Parameters:** @@ -563,7 +563,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_primitive_method_.methodindex.md b/docs/types/classes/_primitive_method_.methodindex.md index 126188e929..b9c155e4f9 100644 --- a/docs/types/classes/_primitive_method_.methodindex.md +++ b/docs/types/classes/_primitive_method_.methodindex.md @@ -27,7 +27,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [primitive/Method.ts:57](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L57)* +*Defined in [primitive/Method.ts:57](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L57)* **Parameters:** @@ -115,7 +115,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -130,7 +130,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -147,7 +147,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -178,7 +178,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -233,7 +233,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -727,7 +727,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -751,7 +751,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -768,7 +768,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -802,7 +802,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -819,7 +819,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_primitive_moment_.moment.md b/docs/types/classes/_primitive_moment_.moment.md index 4c4f1527b9..9310256345 100644 --- a/docs/types/classes/_primitive_moment_.moment.md +++ b/docs/types/classes/_primitive_moment_.moment.md @@ -24,7 +24,7 @@ ⊕ **new Moment**(value?: *[Moment](_primitive_moment_.moment.md) \| `Date` \| [AnyNumber](../modules/_types_.md#anynumber)*): [Moment](_primitive_moment_.moment.md) -*Defined in [primitive/Moment.ts:24](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L24)* +*Defined in [primitive/Moment.ts:24](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L24)* **Parameters:** @@ -56,7 +56,7 @@ ___ getencodedLength(): `number` -*Defined in [primitive/Moment.ts:51](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L51)* +*Defined in [primitive/Moment.ts:51](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L51)* *__description__*: The length of the value when encoded as a Uint8Array @@ -69,7 +69,7 @@ ___ getisEmpty(): `boolean` -*Defined in [primitive/Moment.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L58)* +*Defined in [primitive/Moment.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L58)* *__description__*: Checks if the value is an empty value @@ -85,7 +85,7 @@ ___ ▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) -*Defined in [primitive/Moment.ts:72](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L72)* +*Defined in [primitive/Moment.ts:72](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L72)* *__description__*: Returns the number of bits in the value @@ -100,7 +100,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [primitive/Moment.ts:65](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L65)* +*Defined in [primitive/Moment.ts:65](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L65)* *__description__*: Compares the value of the input to see if there is a match @@ -119,7 +119,7 @@ ___ ▸ **toBn**(): `BN` -*Defined in [primitive/Moment.ts:79](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L79)* +*Defined in [primitive/Moment.ts:79](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L79)* *__description__*: Returns the BN representation of the timestamp @@ -134,7 +134,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [primitive/Moment.ts:86](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L86)* +*Defined in [primitive/Moment.ts:86](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L86)* *__description__*: Returns a hex string representation of the value @@ -151,7 +151,7 @@ ___ *Overrides Date.toJSON* -*Defined in [primitive/Moment.ts:93](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L93)* +*Defined in [primitive/Moment.ts:93](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L93)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -164,7 +164,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [primitive/Moment.ts:100](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L100)* +*Defined in [primitive/Moment.ts:100](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L100)* *__description__*: Returns the number representation for the timestamp @@ -181,7 +181,7 @@ ___ *Overrides Date.toString* -*Defined in [primitive/Moment.ts:107](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L107)* +*Defined in [primitive/Moment.ts:107](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L107)* *__description__*: Returns the string representation of the value @@ -196,7 +196,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [primitive/Moment.ts:116](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L116)* +*Defined in [primitive/Moment.ts:116](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L116)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -215,7 +215,7 @@ ___ ▸ **decodeMoment**(value: *[Moment](_primitive_moment_.moment.md) \| `Date` \| [AnyNumber](../modules/_types_.md#anynumber)*): `Date` -*Defined in [primitive/Moment.ts:34](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L34)* +*Defined in [primitive/Moment.ts:34](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L34)* **Parameters:** diff --git a/docs/types/classes/_primitive_moment_.momentof.md b/docs/types/classes/_primitive_moment_.momentof.md index 0a43be8f74..49233deb66 100644 --- a/docs/types/classes/_primitive_moment_.momentof.md +++ b/docs/types/classes/_primitive_moment_.momentof.md @@ -24,7 +24,7 @@ *Inherited from [Moment](_primitive_moment_.moment.md).[constructor](_primitive_moment_.moment.md#constructor)* -*Defined in [primitive/Moment.ts:24](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L24)* +*Defined in [primitive/Moment.ts:24](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L24)* **Parameters:** @@ -65,7 +65,7 @@ getencodedLength(): `number` *Inherited from [Moment](_primitive_moment_.moment.md).[encodedLength](_primitive_moment_.moment.md#encodedlength)* -*Defined in [primitive/Moment.ts:51](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L51)* +*Defined in [primitive/Moment.ts:51](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L51)* *__description__*: The length of the value when encoded as a Uint8Array @@ -80,7 +80,7 @@ getisEmpty(): `boolean` *Inherited from [Moment](_primitive_moment_.moment.md).[isEmpty](_primitive_moment_.moment.md#isempty)* -*Defined in [primitive/Moment.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L58)* +*Defined in [primitive/Moment.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L58)* *__description__*: Checks if the value is an empty value @@ -170,7 +170,7 @@ ___ *Inherited from [Moment](_primitive_moment_.moment.md).[bitLength](_primitive_moment_.moment.md#bitlength)* -*Defined in [primitive/Moment.ts:72](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L72)* +*Defined in [primitive/Moment.ts:72](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L72)* *__description__*: Returns the number of bits in the value @@ -187,7 +187,7 @@ ___ *Inherited from [Moment](_primitive_moment_.moment.md).[eq](_primitive_moment_.moment.md#eq)* -*Defined in [primitive/Moment.ts:65](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L65)* +*Defined in [primitive/Moment.ts:65](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L65)* *__description__*: Compares the value of the input to see if there is a match @@ -811,7 +811,7 @@ ___ *Inherited from [Moment](_primitive_moment_.moment.md).[toBn](_primitive_moment_.moment.md#tobn)* -*Defined in [primitive/Moment.ts:79](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L79)* +*Defined in [primitive/Moment.ts:79](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L79)* *__description__*: Returns the BN representation of the timestamp @@ -843,7 +843,7 @@ ___ *Inherited from [Moment](_primitive_moment_.moment.md).[toHex](_primitive_moment_.moment.md#tohex)* -*Defined in [primitive/Moment.ts:86](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L86)* +*Defined in [primitive/Moment.ts:86](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L86)* *__description__*: Returns a hex string representation of the value @@ -877,7 +877,7 @@ ___ *Overrides Date.toJSON* -*Defined in [primitive/Moment.ts:93](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L93)* +*Defined in [primitive/Moment.ts:93](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L93)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -937,7 +937,7 @@ ___ *Inherited from [Moment](_primitive_moment_.moment.md).[toNumber](_primitive_moment_.moment.md#tonumber)* -*Defined in [primitive/Moment.ts:100](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L100)* +*Defined in [primitive/Moment.ts:100](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L100)* *__description__*: Returns the number representation for the timestamp @@ -956,7 +956,7 @@ ___ *Overrides Date.toString* -*Defined in [primitive/Moment.ts:107](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L107)* +*Defined in [primitive/Moment.ts:107](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L107)* *__description__*: Returns the string representation of the value @@ -988,7 +988,7 @@ ___ *Inherited from [Moment](_primitive_moment_.moment.md).[toU8a](_primitive_moment_.moment.md#tou8a)* -*Defined in [primitive/Moment.ts:116](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L116)* +*Defined in [primitive/Moment.ts:116](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L116)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1039,7 +1039,7 @@ ___ *Inherited from [Moment](_primitive_moment_.moment.md).[decodeMoment](_primitive_moment_.moment.md#decodemoment)* -*Defined in [primitive/Moment.ts:34](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Moment.ts#L34)* +*Defined in [primitive/Moment.ts:34](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Moment.ts#L34)* **Parameters:** diff --git a/docs/types/classes/_primitive_null_.null.md b/docs/types/classes/_primitive_null_.null.md index 9a57f002a3..67548b505a 100644 --- a/docs/types/classes/_primitive_null_.null.md +++ b/docs/types/classes/_primitive_null_.null.md @@ -36,7 +36,7 @@ getencodedLength(): `number` -*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L17)* +*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L17)* *__description__*: The length of the value when encoded as a Uint8Array @@ -49,7 +49,7 @@ ___ getisEmpty(): `boolean` -*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L24)* +*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L24)* *__description__*: Checks if the value is an empty value (always true) @@ -67,7 +67,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L31)* +*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L31)* *__description__*: Compares the value of the input to see if there is a match @@ -88,7 +88,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L38)* +*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L38)* *__description__*: Returns a hex string representation of the value @@ -103,7 +103,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L45)* +*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L45)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -118,7 +118,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L52)* +*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L52)* *__description__*: Returns the string representation of the value @@ -133,7 +133,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L60)* +*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L60)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_primitive_storagedata_.storagedata.md b/docs/types/classes/_primitive_storagedata_.storagedata.md index bc67d55322..c9e82153f2 100644 --- a/docs/types/classes/_primitive_storagedata_.storagedata.md +++ b/docs/types/classes/_primitive_storagedata_.storagedata.md @@ -29,7 +29,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [primitive/Bytes.ts:18](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bytes.ts#L18)* +*Defined in [primitive/Bytes.ts:18](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bytes.ts#L18)* **Parameters:** @@ -119,7 +119,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [primitive/Bytes.ts:61](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bytes.ts#L61)* +*Defined in [primitive/Bytes.ts:61](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bytes.ts#L61)* *__description__*: The length of the value when encoded as a Uint8Array @@ -134,7 +134,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -151,7 +151,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -222,7 +222,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -716,7 +716,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -740,7 +740,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -757,7 +757,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -791,7 +791,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -810,7 +810,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [primitive/Bytes.ts:69](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bytes.ts#L69)* +*Defined in [primitive/Bytes.ts:69](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bytes.ts#L69)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_primitive_storagekey_.storagekey.md b/docs/types/classes/_primitive_storagekey_.storagekey.md index 77ec82855d..f9a579c833 100644 --- a/docs/types/classes/_primitive_storagekey_.storagekey.md +++ b/docs/types/classes/_primitive_storagekey_.storagekey.md @@ -27,7 +27,7 @@ *Overrides [Bytes](_primitive_bytes_.bytes.md).[constructor](_primitive_bytes_.bytes.md#constructor)* -*Defined in [primitive/StorageKey.ts:28](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/StorageKey.ts#L28)* +*Defined in [primitive/StorageKey.ts:28](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/StorageKey.ts#L28)* **Parameters:** @@ -117,7 +117,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [primitive/Bytes.ts:61](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bytes.ts#L61)* +*Defined in [primitive/Bytes.ts:61](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bytes.ts#L61)* *__description__*: The length of the value when encoded as a Uint8Array @@ -132,7 +132,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -149,7 +149,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -162,7 +162,7 @@ ___ getmeta(): [StorageFunctionMetadata](_metadata_v0_modules_.storagefunctionmetadata.md) \| `null` -*Defined in [primitive/StorageKey.ts:82](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/StorageKey.ts#L82)* +*Defined in [primitive/StorageKey.ts:82](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/StorageKey.ts#L82)* *__description__*: The metadata or `null` when not available @@ -175,7 +175,7 @@ ___ getoutputType(): `string` \| `null` -*Defined in [primitive/StorageKey.ts:89](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/StorageKey.ts#L89)* +*Defined in [primitive/StorageKey.ts:89](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/StorageKey.ts#L89)* *__description__*: The output type, `null` when not available @@ -246,7 +246,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -740,7 +740,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -764,7 +764,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -781,7 +781,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -815,7 +815,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -834,7 +834,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [primitive/Bytes.ts:69](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bytes.ts#L69)* +*Defined in [primitive/Bytes.ts:69](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bytes.ts#L69)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -868,7 +868,7 @@ ___ ▸ **decodeStorageKey**(value: *[AnyU8a](../modules/_types_.md#anyu8a) \| [StorageKey](_primitive_storagekey_.storagekey.md) \| [StorageFunction](../interfaces/_primitive_storagekey_.storagefunction.md) \| [[StorageFunction](../interfaces/_primitive_storagekey_.storagefunction.md), `any`]*): `Uint8Array` -*Defined in [primitive/StorageKey.ts:37](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/StorageKey.ts#L37)* +*Defined in [primitive/StorageKey.ts:37](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/StorageKey.ts#L37)* **Parameters:** @@ -885,7 +885,7 @@ ___ ▸ **getMeta**(value: *[StorageKey](_primitive_storagekey_.storagekey.md) \| [StorageFunction](../interfaces/_primitive_storagekey_.storagefunction.md) \| [[StorageFunction](../interfaces/_primitive_storagekey_.storagefunction.md), `any`]*): [StorageFunctionMetadata](_metadata_v0_modules_.storagefunctionmetadata.md) \| `null` -*Defined in [primitive/StorageKey.ts:51](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/StorageKey.ts#L51)* +*Defined in [primitive/StorageKey.ts:51](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/StorageKey.ts#L51)* **Parameters:** @@ -902,7 +902,7 @@ ___ ▸ **getType**(value: *[StorageKey](_primitive_storagekey_.storagekey.md) \| [StorageFunction](../interfaces/_primitive_storagekey_.storagefunction.md) \| [[StorageFunction](../interfaces/_primitive_storagekey_.storagefunction.md), `any`]*): `string` \| `null` -*Defined in [primitive/StorageKey.ts:65](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/StorageKey.ts#L65)* +*Defined in [primitive/StorageKey.ts:65](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/StorageKey.ts#L65)* **Parameters:** diff --git a/docs/types/classes/_primitive_text_.text.md b/docs/types/classes/_primitive_text_.text.md index bba32ad16f..8ed2d0e4ef 100644 --- a/docs/types/classes/_primitive_text_.text.md +++ b/docs/types/classes/_primitive_text_.text.md @@ -27,7 +27,7 @@ ⊕ **new Text**(value?: *[Text](_primitive_text_.text.md) \| `string` \| [AnyU8a](../modules/_types_.md#anyu8a) \| `object`*): [Text](_primitive_text_.text.md) -*Defined in [primitive/Text.ts:23](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Text.ts#L23)* +*Defined in [primitive/Text.ts:23](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Text.ts#L23)* **Parameters:** @@ -61,7 +61,7 @@ ___ getencodedLength(): `number` -*Defined in [primitive/Text.ts:45](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Text.ts#L45)* +*Defined in [primitive/Text.ts:45](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Text.ts#L45)* *__description__*: The length of the value when encoded as a Uint8Array @@ -74,7 +74,7 @@ ___ getisEmpty(): `boolean` -*Defined in [primitive/Text.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Text.ts#L52)* +*Defined in [primitive/Text.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Text.ts#L52)* *__description__*: Checks if the value is an empty value @@ -89,7 +89,7 @@ getlength(): `number` *Overrides String.length* -*Defined in [primitive/Text.ts:59](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Text.ts#L59)* +*Defined in [primitive/Text.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Text.ts#L59)* *__description__*: The length of the value @@ -107,7 +107,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [primitive/Text.ts:67](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Text.ts#L67)* +*Defined in [primitive/Text.ts:67](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Text.ts#L67)* *__description__*: Compares the value of the input to see if there is a match @@ -128,7 +128,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [primitive/Text.ts:76](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Text.ts#L76)* +*Defined in [primitive/Text.ts:76](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Text.ts#L76)* *__description__*: Returns a hex string representation of the value @@ -143,7 +143,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [primitive/Text.ts:83](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Text.ts#L83)* +*Defined in [primitive/Text.ts:83](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Text.ts#L83)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -160,7 +160,7 @@ ___ *Overrides String.toString* -*Defined in [primitive/Text.ts:90](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Text.ts#L90)* +*Defined in [primitive/Text.ts:90](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Text.ts#L90)* *__description__*: Returns the string representation of the value @@ -175,7 +175,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [primitive/Text.ts:99](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Text.ts#L99)* +*Defined in [primitive/Text.ts:99](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Text.ts#L99)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_primitive_type_.type.md b/docs/types/classes/_primitive_type_.type.md index a3cf56e2a7..2871e7546a 100644 --- a/docs/types/classes/_primitive_type_.type.md +++ b/docs/types/classes/_primitive_type_.type.md @@ -29,7 +29,7 @@ *Overrides [Text](_primitive_text_.text.md).[constructor](_primitive_text_.text.md#constructor)* -*Defined in [primitive/Type.ts:19](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Type.ts#L19)* +*Defined in [primitive/Type.ts:19](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Type.ts#L19)* **Parameters:** @@ -51,7 +51,7 @@ getencodedLength(): `number` *Overrides [Text](_primitive_text_.text.md).[encodedLength](_primitive_text_.text.md#encodedlength)* -*Defined in [primitive/Type.ts:76](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Type.ts#L76)* +*Defined in [primitive/Type.ts:76](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Type.ts#L76)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ getisEmpty(): `boolean` *Inherited from [Text](_primitive_text_.text.md).[isEmpty](_primitive_text_.text.md#isempty)* -*Defined in [primitive/Text.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Text.ts#L52)* +*Defined in [primitive/Text.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Text.ts#L52)* *__description__*: Checks if the value is an empty value @@ -83,7 +83,7 @@ getlength(): `number` *Overrides String.length* -*Defined in [primitive/Text.ts:59](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Text.ts#L59)* +*Defined in [primitive/Text.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Text.ts#L59)* *__description__*: The length of the value @@ -290,7 +290,7 @@ ___ *Inherited from [Text](_primitive_text_.text.md).[eq](_primitive_text_.text.md#eq)* -*Defined in [primitive/Text.ts:67](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Text.ts#L67)* +*Defined in [primitive/Text.ts:67](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Text.ts#L67)* *__description__*: Compares the value of the input to see if there is a match @@ -872,7 +872,7 @@ ___ *Inherited from [Text](_primitive_text_.text.md).[toHex](_primitive_text_.text.md#tohex)* -*Defined in [primitive/Text.ts:76](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Text.ts#L76)* +*Defined in [primitive/Text.ts:76](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Text.ts#L76)* *__description__*: Returns a hex string representation of the value @@ -889,7 +889,7 @@ ___ *Inherited from [Text](_primitive_text_.text.md).[toJSON](_primitive_text_.text.md#tojson)* -*Defined in [primitive/Text.ts:83](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Text.ts#L83)* +*Defined in [primitive/Text.ts:83](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Text.ts#L83)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -953,7 +953,7 @@ ___ *Overrides String.toString* -*Defined in [primitive/Text.ts:90](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Text.ts#L90)* +*Defined in [primitive/Text.ts:90](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Text.ts#L90)* *__description__*: Returns the string representation of the value @@ -970,7 +970,7 @@ ___ *Overrides [Text](_primitive_text_.text.md).[toU8a](_primitive_text_.text.md#tou8a)* -*Defined in [primitive/Type.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Type.ts#L87)* +*Defined in [primitive/Type.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Type.ts#L87)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_primitive_u128_.u128.md b/docs/types/classes/_primitive_u128_.u128.md index f56998bd3a..e5827167dd 100644 --- a/docs/types/classes/_primitive_u128_.u128.md +++ b/docs/types/classes/_primitive_u128_.u128.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [primitive/U128.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/U128.ts#L14)* +*Defined in [primitive/U128.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/U128.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -63,7 +63,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -203,7 +203,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -378,7 +378,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1542,7 +1542,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1583,7 +1583,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1602,7 +1602,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1655,7 +1655,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1701,7 +1701,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1905,7 +1905,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_primitive_u16_.u16.md b/docs/types/classes/_primitive_u16_.u16.md index 7c63d78ca2..387f9522f7 100644 --- a/docs/types/classes/_primitive_u16_.u16.md +++ b/docs/types/classes/_primitive_u16_.u16.md @@ -24,7 +24,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [primitive/U16.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/U16.ts#L14)* +*Defined in [primitive/U16.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/U16.ts#L14)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -61,7 +61,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -201,7 +201,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -376,7 +376,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1540,7 +1540,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1581,7 +1581,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1600,7 +1600,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1653,7 +1653,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1699,7 +1699,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1903,7 +1903,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_primitive_u256_.u256.md b/docs/types/classes/_primitive_u256_.u256.md index 3dc61786d1..d4bf17ee7a 100644 --- a/docs/types/classes/_primitive_u256_.u256.md +++ b/docs/types/classes/_primitive_u256_.u256.md @@ -24,7 +24,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [primitive/U256.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/U256.ts#L14)* +*Defined in [primitive/U256.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/U256.ts#L14)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -61,7 +61,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -201,7 +201,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -376,7 +376,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1540,7 +1540,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1581,7 +1581,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1600,7 +1600,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1653,7 +1653,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1699,7 +1699,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1903,7 +1903,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_primitive_u32_.u32.md b/docs/types/classes/_primitive_u32_.u32.md index f46e5e84a8..ba20dd6e37 100644 --- a/docs/types/classes/_primitive_u32_.u32.md +++ b/docs/types/classes/_primitive_u32_.u32.md @@ -44,7 +44,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/U32.ts#L14)* +*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/U32.ts#L14)* **Parameters:** @@ -66,7 +66,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -81,7 +81,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -221,7 +221,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -396,7 +396,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1560,7 +1560,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1601,7 +1601,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1620,7 +1620,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1673,7 +1673,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1719,7 +1719,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1923,7 +1923,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_primitive_u64_.u64.md b/docs/types/classes/_primitive_u64_.u64.md index 48e9eeb2a3..35f255f9f8 100644 --- a/docs/types/classes/_primitive_u64_.u64.md +++ b/docs/types/classes/_primitive_u64_.u64.md @@ -32,7 +32,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [primitive/U64.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/U64.ts#L14)* +*Defined in [primitive/U64.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/U64.ts#L14)* **Parameters:** @@ -54,7 +54,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -69,7 +69,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -209,7 +209,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -384,7 +384,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1548,7 +1548,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1589,7 +1589,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1608,7 +1608,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1661,7 +1661,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1707,7 +1707,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1911,7 +1911,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_primitive_u8_.u8.md b/docs/types/classes/_primitive_u8_.u8.md index 6e26772393..065d3ab8aa 100644 --- a/docs/types/classes/_primitive_u8_.u8.md +++ b/docs/types/classes/_primitive_u8_.u8.md @@ -24,7 +24,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [primitive/U8.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/U8.ts#L14)* +*Defined in [primitive/U8.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/U8.ts#L14)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -61,7 +61,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -201,7 +201,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -376,7 +376,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1540,7 +1540,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1581,7 +1581,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1600,7 +1600,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1653,7 +1653,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1699,7 +1699,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1903,7 +1903,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_primitive_usize_.usize.md b/docs/types/classes/_primitive_usize_.usize.md index fe0b0e6515..a86f254b89 100644 --- a/docs/types/classes/_primitive_usize_.usize.md +++ b/docs/types/classes/_primitive_usize_.usize.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [primitive/U64.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/U64.ts#L14)* +*Defined in [primitive/U64.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/U64.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -63,7 +63,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -203,7 +203,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -378,7 +378,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1542,7 +1542,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1583,7 +1583,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1602,7 +1602,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1655,7 +1655,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1701,7 +1701,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1905,7 +1905,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_type_accountid_.accountid.md b/docs/types/classes/_type_accountid_.accountid.md index 9c1814915a..a7f21e2516 100644 --- a/docs/types/classes/_type_accountid_.accountid.md +++ b/docs/types/classes/_type_accountid_.accountid.md @@ -31,7 +31,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [type/AccountId.ts:19](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountId.ts#L19)* +*Defined in [type/AccountId.ts:19](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountId.ts#L19)* **Parameters:** @@ -119,7 +119,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/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -134,7 +134,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -151,7 +151,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -182,7 +182,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -237,7 +237,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [type/AccountId.ts:46](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountId.ts#L46)* +*Defined in [type/AccountId.ts:46](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountId.ts#L46)* *__description__*: Compares the value of the input to see if there is a match @@ -731,7 +731,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -755,7 +755,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -772,7 +772,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [type/AccountId.ts:53](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountId.ts#L53)* +*Defined in [type/AccountId.ts:53](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountId.ts#L53)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -804,7 +804,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Defined in [type/AccountId.ts:60](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountId.ts#L60)* +*Defined in [type/AccountId.ts:60](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountId.ts#L60)* *__description__*: Returns the string representation of the value @@ -821,7 +821,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -855,7 +855,7 @@ ___ ▸ **encode**(value: *`Uint8Array`*): `string` -*Defined in [type/AccountId.ts:27](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountId.ts#L27)* +*Defined in [type/AccountId.ts:27](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountId.ts#L27)* **Parameters:** diff --git a/docs/types/classes/_type_accountid_.accountidof.md b/docs/types/classes/_type_accountid_.accountidof.md index 30b2f4fadf..f4d3209e6c 100644 --- a/docs/types/classes/_type_accountid_.accountidof.md +++ b/docs/types/classes/_type_accountid_.accountidof.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [type/AccountId.ts:19](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountId.ts#L19)* +*Defined in [type/AccountId.ts:19](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountId.ts#L19)* **Parameters:** @@ -117,7 +117,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -132,7 +132,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -149,7 +149,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -180,7 +180,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -237,7 +237,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [type/AccountId.ts:46](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountId.ts#L46)* +*Defined in [type/AccountId.ts:46](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountId.ts#L46)* *__description__*: Compares the value of the input to see if there is a match @@ -731,7 +731,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -755,7 +755,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -774,7 +774,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [type/AccountId.ts:53](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountId.ts#L53)* +*Defined in [type/AccountId.ts:53](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountId.ts#L53)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -808,7 +808,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Defined in [type/AccountId.ts:60](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountId.ts#L60)* +*Defined in [type/AccountId.ts:60](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountId.ts#L60)* *__description__*: Returns the string representation of the value @@ -825,7 +825,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -861,7 +861,7 @@ ___ *Inherited from [AccountId](_type_accountid_.accountid.md).[encode](_type_accountid_.accountid.md#encode)* -*Defined in [type/AccountId.ts:27](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountId.ts#L27)* +*Defined in [type/AccountId.ts:27](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountId.ts#L27)* **Parameters:** diff --git a/docs/types/classes/_type_accountindex_.accountindex.md b/docs/types/classes/_type_accountindex_.accountindex.md index e4c1e0c712..58fc1cf8db 100644 --- a/docs/types/classes/_type_accountindex_.accountindex.md +++ b/docs/types/classes/_type_accountindex_.accountindex.md @@ -24,7 +24,7 @@ *Overrides [U32](_primitive_u32_.u32.md).[constructor](_primitive_u32_.u32.md#constructor)* -*Defined in [type/AccountIndex.ts:28](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountIndex.ts#L28)* +*Defined in [type/AccountIndex.ts:28](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountIndex.ts#L28)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -61,7 +61,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -201,7 +201,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -374,7 +374,7 @@ ___ *Overrides AbstractInt.eq* -*Defined in [type/AccountIndex.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountIndex.ts#L87)* +*Defined in [type/AccountIndex.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountIndex.ts#L87)* *__description__*: Compares the value of the input to see if there is a match @@ -1538,7 +1538,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1579,7 +1579,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1596,7 +1596,7 @@ ___ *Overrides AbstractInt.toJSON* -*Defined in [type/AccountIndex.ts:100](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountIndex.ts#L100)* +*Defined in [type/AccountIndex.ts:100](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountIndex.ts#L100)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1649,7 +1649,7 @@ ___ *Overrides AbstractInt.toString* -*Defined in [type/AccountIndex.ts:107](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountIndex.ts#L107)* +*Defined in [type/AccountIndex.ts:107](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountIndex.ts#L107)* *__description__*: Returns the string representation of the value @@ -1689,7 +1689,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1891,7 +1891,7 @@ ___ ▸ **calcLength**(_value: *`BN` \| `number`*): `number` -*Defined in [type/AccountIndex.ts:47](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountIndex.ts#L47)* +*Defined in [type/AccountIndex.ts:47](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountIndex.ts#L47)* **Parameters:** @@ -1910,7 +1910,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** @@ -1929,7 +1929,7 @@ ___ ▸ **decodeAccountIndex**(value: *[AnyNumber](../modules/_types_.md#anynumber)*): `BN` \| `Uint8Array` \| `number` \| `string` -*Defined in [type/AccountIndex.ts:35](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountIndex.ts#L35)* +*Defined in [type/AccountIndex.ts:35](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountIndex.ts#L35)* **Parameters:** @@ -2032,7 +2032,7 @@ ___ ▸ **readLength**(input: *`Uint8Array`*): [`number`, `number`] -*Defined in [type/AccountIndex.ts:61](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountIndex.ts#L61)* +*Defined in [type/AccountIndex.ts:61](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountIndex.ts#L61)* **Parameters:** @@ -2070,7 +2070,7 @@ ___ ▸ **writeLength**(input: *`Uint8Array`*): `Uint8Array` -*Defined in [type/AccountIndex.ts:75](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountIndex.ts#L75)* +*Defined in [type/AccountIndex.ts:75](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountIndex.ts#L75)* **Parameters:** diff --git a/docs/types/classes/_type_address_.address.md b/docs/types/classes/_type_address_.address.md index be02e68c4f..eb6dd1a1db 100644 --- a/docs/types/classes/_type_address_.address.md +++ b/docs/types/classes/_type_address_.address.md @@ -24,7 +24,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [type/Address.ts:26](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Address.ts#L26)* +*Defined in [type/Address.ts:26](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Address.ts#L26)* **Parameters:** @@ -44,7 +44,7 @@ ___ getencodedLength(): `number` -*Defined in [type/Address.ts:68](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Address.ts#L68)* +*Defined in [type/Address.ts:68](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Address.ts#L68)* *__description__*: The length of the value when encoded as a Uint8Array @@ -57,7 +57,7 @@ ___ getisEmpty(): `boolean` -*Defined in [type/Address.ts:82](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Address.ts#L82)* +*Defined in [type/Address.ts:82](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Address.ts#L82)* *__description__*: Checks if the value is an empty value @@ -70,7 +70,7 @@ ___ getrawLength(): `number` -*Defined in [type/Address.ts:89](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Address.ts#L89)* +*Defined in [type/Address.ts:89](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Address.ts#L89)* *__description__*: The length of the raw value, either AccountIndex or AccountId @@ -88,7 +88,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [type/Address.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Address.ts#L98)* +*Defined in [type/Address.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Address.ts#L98)* *__description__*: Compares the value of the input to see if there is a match @@ -109,7 +109,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [type/Address.ts:105](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Address.ts#L105)* +*Defined in [type/Address.ts:105](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Address.ts#L105)* *__description__*: Returns a hex string representation of the value @@ -124,7 +124,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [type/Address.ts:112](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Address.ts#L112)* +*Defined in [type/Address.ts:112](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Address.ts#L112)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -139,7 +139,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [type/Address.ts:119](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Address.ts#L119)* +*Defined in [type/Address.ts:119](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Address.ts#L119)* *__description__*: Returns the string representation of the value @@ -154,7 +154,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [type/Address.ts:127](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Address.ts#L127)* +*Defined in [type/Address.ts:127](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Address.ts#L127)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -173,7 +173,7 @@ ___ ▸ **decodeAddress**(value: *`AnyAddress`*): [AccountId](_type_accountid_.accountid.md) \| [AccountIndex](_type_accountindex_.accountindex.md) -*Defined in [type/Address.ts:33](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Address.ts#L33)* +*Defined in [type/Address.ts:33](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Address.ts#L33)* **Parameters:** diff --git a/docs/types/classes/_type_attestedcandidate_.attestedcandidate.md b/docs/types/classes/_type_attestedcandidate_.attestedcandidate.md index f53131b3be..1a1680f4ca 100644 --- a/docs/types/classes/_type_attestedcandidate_.attestedcandidate.md +++ b/docs/types/classes/_type_attestedcandidate_.attestedcandidate.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/AttestedCandidate.ts:88](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AttestedCandidate.ts#L88)* +*Defined in [type/AttestedCandidate.ts:88](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AttestedCandidate.ts#L88)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -91,7 +91,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -106,7 +106,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -188,7 +188,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -231,7 +231,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -252,7 +252,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -327,7 +327,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -344,7 +344,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -361,7 +361,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -378,7 +378,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -395,7 +395,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -431,7 +431,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_attestedcandidate_.availabilityvote.md b/docs/types/classes/_type_attestedcandidate_.availabilityvote.md index 2ceaebf36e..9bc5a9c4c9 100644 --- a/docs/types/classes/_type_attestedcandidate_.availabilityvote.md +++ b/docs/types/classes/_type_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/1c6a89b/packages/types/src/codec/Tuple.ts#L22)* +*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L22)* **Parameters:** @@ -62,7 +62,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L75)* +*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L75)* *__description__*: The types definition of the tuple @@ -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/1c6a89b/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -92,7 +92,7 @@ getisEmpty(): `boolean` *Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L68)* *__description__*: Checks if the value is an empty value @@ -217,7 +217,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Compares the value of the input to see if there is a match @@ -285,7 +285,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L140)* +*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L140)* *__description__*: Filters the array with the callback @@ -705,7 +705,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L149)* +*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L149)* *__description__*: Maps the array with the callback @@ -1013,7 +1013,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1030,7 +1030,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Returns a hex string representation of the value @@ -1047,7 +1047,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L105)* +*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L105)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1081,7 +1081,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L114)* +*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L114)* *__description__*: Returns the string representation of the value @@ -1098,7 +1098,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L123)* +*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L123)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1155,7 +1155,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/1c6a89b/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_type_attestedcandidate_.balanceupload.md b/docs/types/classes/_type_attestedcandidate_.balanceupload.md index e4943b69f7..14d9bbc3ce 100644 --- a/docs/types/classes/_type_attestedcandidate_.balanceupload.md +++ b/docs/types/classes/_type_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/1c6a89b/packages/types/src/codec/Tuple.ts#L22)* +*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L22)* **Parameters:** @@ -62,7 +62,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L75)* +*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L75)* *__description__*: The types definition of the tuple @@ -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/1c6a89b/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -92,7 +92,7 @@ getisEmpty(): `boolean` *Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L68)* *__description__*: Checks if the value is an empty value @@ -217,7 +217,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Compares the value of the input to see if there is a match @@ -285,7 +285,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L140)* +*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L140)* *__description__*: Filters the array with the callback @@ -705,7 +705,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L149)* +*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L149)* *__description__*: Maps the array with the callback @@ -1013,7 +1013,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1030,7 +1030,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Returns a hex string representation of the value @@ -1047,7 +1047,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L105)* +*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L105)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1081,7 +1081,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L114)* +*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L114)* *__description__*: Returns the string representation of the value @@ -1098,7 +1098,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L123)* +*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L123)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1155,7 +1155,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/1c6a89b/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_type_attestedcandidate_.candidatereceipt.md b/docs/types/classes/_type_attestedcandidate_.candidatereceipt.md index 99a6a08f65..e6082e73f6 100644 --- a/docs/types/classes/_type_attestedcandidate_.candidatereceipt.md +++ b/docs/types/classes/_type_attestedcandidate_.candidatereceipt.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/AttestedCandidate.ts:30](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AttestedCandidate.ts#L30)* +*Defined in [type/AttestedCandidate.ts:30](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AttestedCandidate.ts#L30)* **Parameters:** @@ -72,7 +72,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -87,7 +87,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -102,7 +102,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -184,7 +184,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -227,7 +227,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -248,7 +248,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -323,7 +323,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -340,7 +340,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -357,7 +357,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -374,7 +374,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -391,7 +391,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -427,7 +427,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_attestedcandidate_.candidatesignature.md b/docs/types/classes/_type_attestedcandidate_.candidatesignature.md index 5c2bc40462..93e7a52e7c 100644 --- a/docs/types/classes/_type_attestedcandidate_.candidatesignature.md +++ b/docs/types/classes/_type_attestedcandidate_.candidatesignature.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [primitive/H512.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/H512.ts#L14)* +*Defined in [primitive/H512.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/H512.ts#L14)* **Parameters:** @@ -117,7 +117,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -132,7 +132,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -149,7 +149,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -180,7 +180,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -235,7 +235,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -729,7 +729,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -753,7 +753,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -770,7 +770,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -804,7 +804,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -821,7 +821,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_attestedcandidate_.egressqueueroot.md b/docs/types/classes/_type_attestedcandidate_.egressqueueroot.md index b58b339409..ea1c37c145 100644 --- a/docs/types/classes/_type_attestedcandidate_.egressqueueroot.md +++ b/docs/types/classes/_type_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/1c6a89b/packages/types/src/codec/Tuple.ts#L22)* +*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L22)* **Parameters:** @@ -62,7 +62,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L75)* +*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L75)* *__description__*: The types definition of the tuple @@ -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/1c6a89b/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -92,7 +92,7 @@ getisEmpty(): `boolean` *Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L68)* *__description__*: Checks if the value is an empty value @@ -217,7 +217,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Compares the value of the input to see if there is a match @@ -285,7 +285,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L140)* +*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L140)* *__description__*: Filters the array with the callback @@ -705,7 +705,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L149)* +*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L149)* *__description__*: Maps the array with the callback @@ -1013,7 +1013,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1030,7 +1030,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Returns a hex string representation of the value @@ -1047,7 +1047,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L105)* +*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L105)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1081,7 +1081,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L114)* +*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L114)* *__description__*: Returns the string representation of the value @@ -1098,7 +1098,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L123)* +*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L123)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1155,7 +1155,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/1c6a89b/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_type_attestedcandidate_.explicitcandidatesignature.md b/docs/types/classes/_type_attestedcandidate_.explicitcandidatesignature.md index b50b9ad65d..5b3bf5ab0a 100644 --- a/docs/types/classes/_type_attestedcandidate_.explicitcandidatesignature.md +++ b/docs/types/classes/_type_attestedcandidate_.explicitcandidatesignature.md @@ -25,7 +25,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [primitive/H512.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/H512.ts#L14)* +*Defined in [primitive/H512.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/H512.ts#L14)* **Parameters:** @@ -113,7 +113,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/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -128,7 +128,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -145,7 +145,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -176,7 +176,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -231,7 +231,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -725,7 +725,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -749,7 +749,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -766,7 +766,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -800,7 +800,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -817,7 +817,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_attestedcandidate_.headdata.md b/docs/types/classes/_type_attestedcandidate_.headdata.md index 5f225b2115..d7d946fe6c 100644 --- a/docs/types/classes/_type_attestedcandidate_.headdata.md +++ b/docs/types/classes/_type_attestedcandidate_.headdata.md @@ -25,7 +25,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [primitive/Bytes.ts:18](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bytes.ts#L18)* +*Defined in [primitive/Bytes.ts:18](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bytes.ts#L18)* **Parameters:** @@ -115,7 +115,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [primitive/Bytes.ts:61](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bytes.ts#L61)* +*Defined in [primitive/Bytes.ts:61](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bytes.ts#L61)* *__description__*: The length of the value when encoded as a Uint8Array @@ -130,7 +130,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -147,7 +147,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -218,7 +218,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -712,7 +712,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -736,7 +736,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -753,7 +753,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -787,7 +787,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -806,7 +806,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [primitive/Bytes.ts:69](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bytes.ts#L69)* +*Defined in [primitive/Bytes.ts:69](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bytes.ts#L69)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_attestedcandidate_.implicitcandidatesignature.md b/docs/types/classes/_type_attestedcandidate_.implicitcandidatesignature.md index 49a80d90da..c7849aa370 100644 --- a/docs/types/classes/_type_attestedcandidate_.implicitcandidatesignature.md +++ b/docs/types/classes/_type_attestedcandidate_.implicitcandidatesignature.md @@ -25,7 +25,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [primitive/H512.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/H512.ts#L14)* +*Defined in [primitive/H512.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/H512.ts#L14)* **Parameters:** @@ -113,7 +113,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/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -128,7 +128,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -145,7 +145,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -176,7 +176,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -231,7 +231,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -725,7 +725,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -749,7 +749,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -766,7 +766,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -800,7 +800,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -817,7 +817,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_attestedcandidate_.validityattestation.md b/docs/types/classes/_type_attestedcandidate_.validityattestation.md index 620ad60721..51f2af00c8 100644 --- a/docs/types/classes/_type_attestedcandidate_.validityattestation.md +++ b/docs/types/classes/_type_attestedcandidate_.validityattestation.md @@ -20,7 +20,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [type/AttestedCandidate.ts:54](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AttestedCandidate.ts#L54)* +*Defined in [type/AttestedCandidate.ts:54](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AttestedCandidate.ts#L54)* **Parameters:** @@ -40,7 +40,7 @@ ___ getasExplicitCandidateSignature(): [ExplicitCandidateSignature](_type_attestedcandidate_.explicitcandidatesignature.md) -*Defined in [type/AttestedCandidate.ts:68](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AttestedCandidate.ts#L68)* +*Defined in [type/AttestedCandidate.ts:68](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AttestedCandidate.ts#L68)* *__description__*: Returns the item as a [ExplicitCandidateSignature](_type_attestedcandidate_.explicitcandidatesignature.md) @@ -53,7 +53,7 @@ ___ getasImplicitCandidateSignature(): [ImplicitCandidateSignature](_type_attestedcandidate_.implicitcandidatesignature.md) -*Defined in [type/AttestedCandidate.ts:75](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AttestedCandidate.ts#L75)* +*Defined in [type/AttestedCandidate.ts:75](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AttestedCandidate.ts#L75)* *__description__*: Returns the item as a [ImplicitCandidateSignature](_type_attestedcandidate_.implicitcandidatesignature.md) @@ -68,7 +68,7 @@ getencodedLength(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L114)* +*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L114)* *__description__*: The length of the value when encoded as a Uint8Array @@ -83,7 +83,7 @@ getindex(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L121)* +*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L121)* *__description__*: The index of the metadata value @@ -98,7 +98,7 @@ getisEmpty(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isEmpty](_codec_enumtype_.enumtype.md#isempty)* -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L128)* +*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L128)* *__description__*: Checks if the value is an empty value @@ -113,7 +113,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L135)* +*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L135)* *__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type @@ -128,7 +128,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L142)* +*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L142)* *__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type (deprecated, use isNone) @@ -143,7 +143,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L149)* +*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L149)* *__description__*: The name of the type this enum value represents @@ -158,7 +158,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:156](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L156)* +*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L156)* *__description__*: The value of the enum @@ -178,7 +178,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* -*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L163)* +*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L163)* *__description__*: Compares the value of the input to see if there is a match @@ -201,7 +201,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L176)* +*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L176)* *__description__*: Returns a hex string representation of the value @@ -218,7 +218,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L183)* +*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L183)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -233,7 +233,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L192)* +*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L192)* *__description__*: Returns the number representation for the value @@ -250,7 +250,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [codec/EnumType.ts:199](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L199)* +*Defined in [codec/EnumType.ts:199](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L199)* *__description__*: Returns the string representation of the value @@ -267,7 +267,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L209)* +*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -288,7 +288,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L101)* +*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L101)* **Type parameters:** diff --git a/docs/types/classes/_type_attestedcandidate_.validityvote.md b/docs/types/classes/_type_attestedcandidate_.validityvote.md index 9d019d0e3d..c670a84da3 100644 --- a/docs/types/classes/_type_attestedcandidate_.validityvote.md +++ b/docs/types/classes/_type_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/1c6a89b/packages/types/src/codec/Tuple.ts#L22)* +*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L22)* **Parameters:** @@ -62,7 +62,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L75)* +*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L75)* *__description__*: The types definition of the tuple @@ -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/1c6a89b/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -92,7 +92,7 @@ getisEmpty(): `boolean` *Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L68)* *__description__*: Checks if the value is an empty value @@ -217,7 +217,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Compares the value of the input to see if there is a match @@ -285,7 +285,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L140)* +*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L140)* *__description__*: Filters the array with the callback @@ -705,7 +705,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L149)* +*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L149)* *__description__*: Maps the array with the callback @@ -1013,7 +1013,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1030,7 +1030,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Returns a hex string representation of the value @@ -1047,7 +1047,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L105)* +*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L105)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1081,7 +1081,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L114)* +*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L114)* *__description__*: Returns the string representation of the value @@ -1098,7 +1098,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L123)* +*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L123)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1155,7 +1155,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/1c6a89b/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_type_authorityid_.authorityid.md b/docs/types/classes/_type_authorityid_.authorityid.md index 3f3815622f..ceca9c5b25 100644 --- a/docs/types/classes/_type_authorityid_.authorityid.md +++ b/docs/types/classes/_type_authorityid_.authorityid.md @@ -27,7 +27,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [type/AccountId.ts:19](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountId.ts#L19)* +*Defined in [type/AccountId.ts:19](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountId.ts#L19)* **Parameters:** @@ -115,7 +115,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -130,7 +130,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -147,7 +147,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -178,7 +178,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -235,7 +235,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [type/AccountId.ts:46](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountId.ts#L46)* +*Defined in [type/AccountId.ts:46](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountId.ts#L46)* *__description__*: Compares the value of the input to see if there is a match @@ -729,7 +729,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -753,7 +753,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -772,7 +772,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [type/AccountId.ts:53](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountId.ts#L53)* +*Defined in [type/AccountId.ts:53](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountId.ts#L53)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -806,7 +806,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Defined in [type/AccountId.ts:60](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountId.ts#L60)* +*Defined in [type/AccountId.ts:60](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountId.ts#L60)* *__description__*: Returns the string representation of the value @@ -823,7 +823,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -859,7 +859,7 @@ ___ *Inherited from [AccountId](_type_accountid_.accountid.md).[encode](_type_accountid_.accountid.md#encode)* -*Defined in [type/AccountId.ts:27](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountId.ts#L27)* +*Defined in [type/AccountId.ts:27](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountId.ts#L27)* **Parameters:** diff --git a/docs/types/classes/_type_balance_.balance.md b/docs/types/classes/_type_balance_.balance.md index 30f932b2c8..3a668f65a2 100644 --- a/docs/types/classes/_type_balance_.balance.md +++ b/docs/types/classes/_type_balance_.balance.md @@ -28,7 +28,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [primitive/U128.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/U128.ts#L14)* +*Defined in [primitive/U128.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/U128.ts#L14)* **Parameters:** @@ -50,7 +50,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -65,7 +65,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -205,7 +205,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -380,7 +380,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1544,7 +1544,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1585,7 +1585,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1604,7 +1604,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1657,7 +1657,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1703,7 +1703,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1907,7 +1907,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_type_balance_.balanceof.md b/docs/types/classes/_type_balance_.balanceof.md index 6d5a7472ba..fb78b92022 100644 --- a/docs/types/classes/_type_balance_.balanceof.md +++ b/docs/types/classes/_type_balance_.balanceof.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [primitive/U128.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/U128.ts#L14)* +*Defined in [primitive/U128.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/U128.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -63,7 +63,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -203,7 +203,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -378,7 +378,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1542,7 +1542,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1583,7 +1583,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1602,7 +1602,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1655,7 +1655,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1701,7 +1701,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1905,7 +1905,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_type_bft_.bftauthoritysignature.md b/docs/types/classes/_type_bft_.bftauthoritysignature.md index 83ba64e9cd..3483ba55c3 100644 --- a/docs/types/classes/_type_bft_.bftauthoritysignature.md +++ b/docs/types/classes/_type_bft_.bftauthoritysignature.md @@ -27,7 +27,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [type/Bft.ts:20](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Bft.ts#L20)* +*Defined in [type/Bft.ts:20](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Bft.ts#L20)* **Parameters:** @@ -65,7 +65,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L75)* +*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L75)* *__description__*: The types definition of the tuple @@ -78,7 +78,7 @@ ___ getauthorityId(): [AuthorityId](_type_authorityid_.authorityid.md) -*Defined in [type/Bft.ts:31](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Bft.ts#L31)* +*Defined in [type/Bft.ts:31](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Bft.ts#L31)* *__description__*: The wrapped \[\[AuthoriyId\]\] @@ -93,7 +93,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/1c6a89b/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -108,7 +108,7 @@ getisEmpty(): `boolean` *Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L68)* *__description__*: Checks if the value is an empty value @@ -121,7 +121,7 @@ ___ getsignature(): [Signature](_type_signature_.signature.md) -*Defined in [type/Bft.ts:38](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Bft.ts#L38)* +*Defined in [type/Bft.ts:38](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Bft.ts#L38)* *__description__*: The wrapped [Signature](_type_signature_.signature.md) value @@ -246,7 +246,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Compares the value of the input to see if there is a match @@ -314,7 +314,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L140)* +*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L140)* *__description__*: Filters the array with the callback @@ -734,7 +734,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L149)* +*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L149)* *__description__*: Maps the array with the callback @@ -1042,7 +1042,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1059,7 +1059,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Returns a hex string representation of the value @@ -1076,7 +1076,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L105)* +*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L105)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1110,7 +1110,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L114)* +*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L114)* *__description__*: Returns the string representation of the value @@ -1127,7 +1127,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L123)* +*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L123)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1184,7 +1184,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/1c6a89b/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_type_bft_.bfthashsignature.md b/docs/types/classes/_type_bft_.bfthashsignature.md index bbe2b918cf..87cb0af51e 100644 --- a/docs/types/classes/_type_bft_.bfthashsignature.md +++ b/docs/types/classes/_type_bft_.bfthashsignature.md @@ -27,7 +27,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [type/Bft.ts:51](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Bft.ts#L51)* +*Defined in [type/Bft.ts:51](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Bft.ts#L51)* **Parameters:** @@ -65,7 +65,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L75)* +*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L75)* *__description__*: The types definition of the tuple @@ -80,7 +80,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/1c6a89b/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -93,7 +93,7 @@ ___ gethash(): [Hash](_type_hash_.hash.md) -*Defined in [type/Bft.ts:62](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Bft.ts#L62)* +*Defined in [type/Bft.ts:62](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Bft.ts#L62)* *__description__*: The wrapped [Hash](_type_hash_.hash.md) @@ -108,7 +108,7 @@ getisEmpty(): `boolean` *Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L68)* *__description__*: Checks if the value is an empty value @@ -121,7 +121,7 @@ ___ getsignature(): [Signature](_type_signature_.signature.md) -*Defined in [type/Bft.ts:69](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Bft.ts#L69)* +*Defined in [type/Bft.ts:69](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Bft.ts#L69)* *__description__*: The wrapped [Signature](_type_signature_.signature.md) @@ -246,7 +246,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Compares the value of the input to see if there is a match @@ -314,7 +314,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L140)* +*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L140)* *__description__*: Filters the array with the callback @@ -734,7 +734,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L149)* +*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L149)* *__description__*: Maps the array with the callback @@ -1042,7 +1042,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1059,7 +1059,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Returns a hex string representation of the value @@ -1076,7 +1076,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L105)* +*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L105)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1110,7 +1110,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L114)* +*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L114)* *__description__*: Returns the string representation of the value @@ -1127,7 +1127,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L123)* +*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L123)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1184,7 +1184,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/1c6a89b/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_type_block_.block.md b/docs/types/classes/_type_block_.block.md index ea3a6bdaec..a617afa47c 100644 --- a/docs/types/classes/_type_block_.block.md +++ b/docs/types/classes/_type_block_.block.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/Block.ts:24](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Block.ts#L24)* +*Defined in [type/Block.ts:24](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Block.ts#L24)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -89,7 +89,7 @@ ___ getcontentHash(): [Hash](_type_hash_.hash.md) -*Defined in [type/Block.ts:35](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Block.ts#L35)* +*Defined in [type/Block.ts:35](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Block.ts#L35)* *__description__*: Encodes a content [Hash](_type_hash_.hash.md) for the block @@ -104,7 +104,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -117,7 +117,7 @@ ___ getextrinsics(): [Extrinsics](_type_extrinsics_.extrinsics.md) -*Defined in [type/Block.ts:44](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Block.ts#L44)* +*Defined in [type/Block.ts:44](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Block.ts#L44)* *__description__*: The [Extrinsics](_type_extrinsics_.extrinsics.md) contained in the block @@ -130,7 +130,7 @@ ___ gethash(): [Hash](_type_hash_.hash.md) -*Defined in [type/Block.ts:51](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Block.ts#L51)* +*Defined in [type/Block.ts:51](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Block.ts#L51)* *__description__*: Block/header [Hash](_type_hash_.hash.md) @@ -143,7 +143,7 @@ ___ getheader(): [Header](_type_header_.header.md) -*Defined in [type/Block.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Block.ts#L58)* +*Defined in [type/Block.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Block.ts#L58)* *__description__*: The [Header](_type_header_.header.md) of the block @@ -158,7 +158,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -240,7 +240,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -283,7 +283,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -304,7 +304,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -379,7 +379,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -396,7 +396,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -413,7 +413,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -430,7 +430,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -447,7 +447,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -483,7 +483,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_blocknumber_.blocknumber.md b/docs/types/classes/_type_blocknumber_.blocknumber.md index 3f680f9a9b..3dbfc27eea 100644 --- a/docs/types/classes/_type_blocknumber_.blocknumber.md +++ b/docs/types/classes/_type_blocknumber_.blocknumber.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [primitive/U64.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/U64.ts#L14)* +*Defined in [primitive/U64.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/U64.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -63,7 +63,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -203,7 +203,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -378,7 +378,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1542,7 +1542,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1583,7 +1583,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1602,7 +1602,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1655,7 +1655,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1701,7 +1701,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1905,7 +1905,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_type_chainproperties_.chainproperties.md b/docs/types/classes/_type_chainproperties_.chainproperties.md index fa7e445ebd..ad38cd65d3 100644 --- a/docs/types/classes/_type_chainproperties_.chainproperties.md +++ b/docs/types/classes/_type_chainproperties_.chainproperties.md @@ -22,7 +22,7 @@ ⊕ **new ChainProperties**(value?: *`object` \| `null`*): [ChainProperties](_type_chainproperties_.chainproperties.md) -*Defined in [type/ChainProperties.ts:17](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ChainProperties.ts#L17)* +*Defined in [type/ChainProperties.ts:17](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ChainProperties.ts#L17)* **Parameters:** @@ -54,7 +54,7 @@ ___ getencodedLength(): `number` -*Defined in [type/ChainProperties.ts:29](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ChainProperties.ts#L29)* +*Defined in [type/ChainProperties.ts:29](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ChainProperties.ts#L29)* *__description__*: Always 0, never encodes as a Uint8Array @@ -67,7 +67,7 @@ ___ getisEmpty(): `boolean` -*Defined in [type/ChainProperties.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ChainProperties.ts#L36)* +*Defined in [type/ChainProperties.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ChainProperties.ts#L36)* *__description__*: Checks if the value is an empty value @@ -80,7 +80,7 @@ ___ gettokenDecimals(): `number` \| `undefined` -*Defined in [type/ChainProperties.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ChainProperties.ts#L43)* +*Defined in [type/ChainProperties.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ChainProperties.ts#L43)* *__description__*: The token decimals, if defined (de-facto standard only) @@ -93,7 +93,7 @@ ___ gettokenSymbol(): `string` \| `undefined` -*Defined in [type/ChainProperties.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ChainProperties.ts#L50)* +*Defined in [type/ChainProperties.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ChainProperties.ts#L50)* *__description__*: The token system, if defined (de-facto standard only) @@ -111,7 +111,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* -*Defined in [type/ChainProperties.ts:57](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ChainProperties.ts#L57)* +*Defined in [type/ChainProperties.ts:57](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ChainProperties.ts#L57)* *__description__*: Compares the value of the input to see if there is a match @@ -132,7 +132,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [type/ChainProperties.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ChainProperties.ts#L64)* +*Defined in [type/ChainProperties.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ChainProperties.ts#L64)* *__description__*: Unimplemented, will throw @@ -147,7 +147,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [type/ChainProperties.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ChainProperties.ts#L71)* +*Defined in [type/ChainProperties.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ChainProperties.ts#L71)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -162,7 +162,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [type/ChainProperties.ts:82](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ChainProperties.ts#L82)* +*Defined in [type/ChainProperties.ts:82](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ChainProperties.ts#L82)* *__description__*: Returns the string representation of the value @@ -177,7 +177,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* -*Defined in [type/ChainProperties.ts:89](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ChainProperties.ts#L89)* +*Defined in [type/ChainProperties.ts:89](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ChainProperties.ts#L89)* *__description__*: Unimplemented, will throw diff --git a/docs/types/classes/_type_codehash_.codehash.md b/docs/types/classes/_type_codehash_.codehash.md index e91754fe9f..9ffbc34985 100644 --- a/docs/types/classes/_type_codehash_.codehash.md +++ b/docs/types/classes/_type_codehash_.codehash.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [primitive/H256.ts:15](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/H256.ts#L15)* +*Defined in [primitive/H256.ts:15](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/H256.ts#L15)* **Parameters:** @@ -117,7 +117,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -132,7 +132,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -149,7 +149,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -180,7 +180,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -235,7 +235,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -729,7 +729,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -753,7 +753,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -770,7 +770,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -804,7 +804,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -821,7 +821,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_digest_.authoritieschange.md b/docs/types/classes/_type_digest_.authoritieschange.md index bf16adf1c3..d4b4f38878 100644 --- a/docs/types/classes/_type_digest_.authoritieschange.md +++ b/docs/types/classes/_type_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/1c6a89b/packages/types/src/codec/Vector.ts#L22)* +*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/6eb859c/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:66](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L66)* +*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L66)* *__description__*: The type for the items @@ -67,7 +67,7 @@ getencodedLength(): `number` *Inherited from [Vector](_codec_vector_.vector.md).[encodedLength](_codec_vector_.vector.md#encodedlength)* -*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L73)* +*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L73)* *__description__*: The length of the value when encoded as a Uint8Array @@ -82,7 +82,7 @@ getisEmpty(): `boolean` *Inherited from [Vector](_codec_vector_.vector.md).[isEmpty](_codec_vector_.vector.md#isempty)* -*Defined in [codec/Vector.ts:59](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L59)* +*Defined in [codec/Vector.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L59)* *__description__*: Checks if the value is an empty value @@ -99,7 +99,7 @@ getlength(): `number` *Overrides Array.length* -*Defined in [codec/Vector.ts:82](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L82)* +*Defined in [codec/Vector.ts:82](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L82)* *__description__*: The length of the value @@ -224,7 +224,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[eq](_codec_vector_.vector.md#eq)* -*Defined in [codec/Vector.ts:90](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L90)* +*Defined in [codec/Vector.ts:90](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L90)* *__description__*: Compares the value of the input to see if there is a match @@ -292,7 +292,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Vector.ts:173](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L173)* +*Defined in [codec/Vector.ts:173](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L173)* *__description__*: Filters the array with the callback @@ -632,7 +632,7 @@ ___ *Overrides Array.indexOf* -*Defined in [codec/Vector.ts:97](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L97)* +*Defined in [codec/Vector.ts:97](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L97)* *__description__*: Finds the index of the value in the array @@ -713,7 +713,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Vector.ts:182](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L182)* +*Defined in [codec/Vector.ts:182](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L182)* *__description__*: Maps the array with the callback @@ -1021,7 +1021,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)* -*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L115)* +*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L115)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1038,7 +1038,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)* -*Defined in [codec/Vector.ts:122](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L122)* +*Defined in [codec/Vector.ts:122](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L122)* *__description__*: Returns a hex string representation of the value @@ -1055,7 +1055,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* -*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L129)* +*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L129)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1089,7 +1089,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Vector.ts:138](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L138)* +*Defined in [codec/Vector.ts:138](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L138)* *__description__*: Returns the string representation of the value @@ -1106,7 +1106,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* -*Defined in [codec/Vector.ts:151](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L151)* +*Defined in [codec/Vector.ts:151](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L151)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1163,7 +1163,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/1c6a89b/packages/types/src/codec/Vector.ts#L32)* +*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L32)* **Type parameters:** @@ -1186,7 +1186,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* -*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L48)* +*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L48)* **Type parameters:** diff --git a/docs/types/classes/_type_digest_.changestrieroot.md b/docs/types/classes/_type_digest_.changestrieroot.md index 541aa9a477..f119a85c9f 100644 --- a/docs/types/classes/_type_digest_.changestrieroot.md +++ b/docs/types/classes/_type_digest_.changestrieroot.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [primitive/H256.ts:15](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/H256.ts#L15)* +*Defined in [primitive/H256.ts:15](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/H256.ts#L15)* **Parameters:** @@ -117,7 +117,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -132,7 +132,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -149,7 +149,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -180,7 +180,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -235,7 +235,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -729,7 +729,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -753,7 +753,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -770,7 +770,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -804,7 +804,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -821,7 +821,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_digest_.digest.md b/docs/types/classes/_type_digest_.digest.md index 10a484ae0b..7a4ea8b697 100644 --- a/docs/types/classes/_type_digest_.digest.md +++ b/docs/types/classes/_type_digest_.digest.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/Digest.ts:117](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Digest.ts#L117)* +*Defined in [type/Digest.ts:117](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Digest.ts#L117)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -91,7 +91,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -106,7 +106,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -119,7 +119,7 @@ ___ getlogs(): [Vector](_codec_vector_.vector.md)<[DigestItem](_type_digest_.digestitem.md)> -*Defined in [type/Digest.ts:127](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Digest.ts#L127)* +*Defined in [type/Digest.ts:127](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Digest.ts#L127)* *__description__*: The [DigestItem](_type_digest_.digestitem.md) logs @@ -201,7 +201,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -244,7 +244,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -265,7 +265,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -340,7 +340,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -357,7 +357,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -374,7 +374,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -391,7 +391,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -408,7 +408,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -444,7 +444,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_digest_.digestitem.md b/docs/types/classes/_type_digest_.digestitem.md index 6755136eb3..c418d01764 100644 --- a/docs/types/classes/_type_digest_.digestitem.md +++ b/docs/types/classes/_type_digest_.digestitem.md @@ -24,7 +24,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [type/Digest.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Digest.ts#L73)* +*Defined in [type/Digest.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Digest.ts#L73)* **Parameters:** @@ -44,7 +44,7 @@ ___ getasAuthoritiesChange(): [AuthoritiesChange](_type_digest_.authoritieschange.md) -*Defined in [type/Digest.ts:86](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Digest.ts#L86)* +*Defined in [type/Digest.ts:86](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Digest.ts#L86)* *__description__*: Returns the item as a [AuthoritiesChange](_type_digest_.authoritieschange.md) @@ -57,7 +57,7 @@ ___ getasChangesTrieRoot(): [ChangesTrieRoot](_type_digest_.changestrieroot.md) -*Defined in [type/Digest.ts:93](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Digest.ts#L93)* +*Defined in [type/Digest.ts:93](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Digest.ts#L93)* *__description__*: Returns the item as a [ChangesTrieRoot](_type_digest_.changestrieroot.md) @@ -70,7 +70,7 @@ ___ getasOther(): [Other](_type_digest_.other.md) -*Defined in [type/Digest.ts:100](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Digest.ts#L100)* +*Defined in [type/Digest.ts:100](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Digest.ts#L100)* *__description__*: Returns the item as a [Other](_type_digest_.other.md) @@ -83,7 +83,7 @@ ___ getasSeal(): [Seal](_type_digest_.seal.md) -*Defined in [type/Digest.ts:107](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Digest.ts#L107)* +*Defined in [type/Digest.ts:107](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Digest.ts#L107)* *__description__*: Returns the item as a [Seal](_type_digest_.seal.md) @@ -98,7 +98,7 @@ getencodedLength(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L114)* +*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L114)* *__description__*: The length of the value when encoded as a Uint8Array @@ -113,7 +113,7 @@ getindex(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L121)* +*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L121)* *__description__*: The index of the metadata value @@ -128,7 +128,7 @@ getisEmpty(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isEmpty](_codec_enumtype_.enumtype.md#isempty)* -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L128)* +*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L128)* *__description__*: Checks if the value is an empty value @@ -143,7 +143,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L135)* +*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L135)* *__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type @@ -158,7 +158,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L142)* +*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L142)* *__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type (deprecated, use isNone) @@ -173,7 +173,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L149)* +*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L149)* *__description__*: The name of the type this enum value represents @@ -188,7 +188,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:156](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L156)* +*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L156)* *__description__*: The value of the enum @@ -208,7 +208,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* -*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L163)* +*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L163)* *__description__*: Compares the value of the input to see if there is a match @@ -231,7 +231,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L176)* +*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L176)* *__description__*: Returns a hex string representation of the value @@ -248,7 +248,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L183)* +*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L183)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -263,7 +263,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L192)* +*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L192)* *__description__*: Returns the number representation for the value @@ -280,7 +280,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [codec/EnumType.ts:199](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L199)* +*Defined in [codec/EnumType.ts:199](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L199)* *__description__*: Returns the string representation of the value @@ -297,7 +297,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L209)* +*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -318,7 +318,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L101)* +*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L101)* **Type parameters:** diff --git a/docs/types/classes/_type_digest_.other.md b/docs/types/classes/_type_digest_.other.md index 39e424c526..d66943b682 100644 --- a/docs/types/classes/_type_digest_.other.md +++ b/docs/types/classes/_type_digest_.other.md @@ -29,7 +29,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [primitive/Bytes.ts:18](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bytes.ts#L18)* +*Defined in [primitive/Bytes.ts:18](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bytes.ts#L18)* **Parameters:** @@ -119,7 +119,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [primitive/Bytes.ts:61](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bytes.ts#L61)* +*Defined in [primitive/Bytes.ts:61](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bytes.ts#L61)* *__description__*: The length of the value when encoded as a Uint8Array @@ -134,7 +134,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -151,7 +151,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -222,7 +222,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -716,7 +716,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -740,7 +740,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -757,7 +757,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -791,7 +791,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -810,7 +810,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [primitive/Bytes.ts:69](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bytes.ts#L69)* +*Defined in [primitive/Bytes.ts:69](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bytes.ts#L69)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_digest_.seal.md b/docs/types/classes/_type_digest_.seal.md index 6080d39e13..969a4a931d 100644 --- a/docs/types/classes/_type_digest_.seal.md +++ b/docs/types/classes/_type_digest_.seal.md @@ -27,7 +27,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [type/Digest.ts:44](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Digest.ts#L44)* +*Defined in [type/Digest.ts:44](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Digest.ts#L44)* **Parameters:** @@ -65,7 +65,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L75)* +*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L75)* *__description__*: The types definition of the tuple @@ -80,7 +80,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/1c6a89b/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -95,7 +95,7 @@ getisEmpty(): `boolean` *Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L68)* *__description__*: Checks if the value is an empty value @@ -108,7 +108,7 @@ ___ getsignature(): [Signature](_type_signature_.signature.md) -*Defined in [type/Digest.ts:55](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Digest.ts#L55)* +*Defined in [type/Digest.ts:55](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Digest.ts#L55)* *__description__*: The wrapped [Signature](_type_signature_.signature.md) @@ -121,7 +121,7 @@ ___ getslot(): [U64](_primitive_u64_.u64.md) -*Defined in [type/Digest.ts:62](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Digest.ts#L62)* +*Defined in [type/Digest.ts:62](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Digest.ts#L62)* *__description__*: The wrapped [U64](_primitive_u64_.u64.md) slot @@ -246,7 +246,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Compares the value of the input to see if there is a match @@ -314,7 +314,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L140)* +*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L140)* *__description__*: Filters the array with the callback @@ -734,7 +734,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L149)* +*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L149)* *__description__*: Maps the array with the callback @@ -1042,7 +1042,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1059,7 +1059,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Returns a hex string representation of the value @@ -1076,7 +1076,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L105)* +*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L105)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1110,7 +1110,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L114)* +*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L114)* *__description__*: Returns the string representation of the value @@ -1127,7 +1127,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L123)* +*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L123)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1184,7 +1184,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/1c6a89b/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_type_event_.event.md b/docs/types/classes/_type_event_.event.md index 7463dbbf6c..01e848366e 100644 --- a/docs/types/classes/_type_event_.event.md +++ b/docs/types/classes/_type_event_.event.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/Event.ts:86](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Event.ts#L86)* +*Defined in [type/Event.ts:86](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Event.ts#L86)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -89,7 +89,7 @@ ___ getdata(): [EventData](_type_event_.eventdata.md) -*Defined in [type/Event.ts:144](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Event.ts#L144)* +*Defined in [type/Event.ts:144](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Event.ts#L144)* *__description__*: The wrapped [EventData](_type_event_.eventdata.md) @@ -104,7 +104,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -117,7 +117,7 @@ ___ getindex(): [EventIndex](_type_event_.eventindex.md) -*Defined in [type/Event.ts:151](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Event.ts#L151)* +*Defined in [type/Event.ts:151](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Event.ts#L151)* *__description__*: The [EventIndex](_type_event_.eventindex.md), identifying the raw event @@ -132,7 +132,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -145,7 +145,7 @@ ___ getmeta(): [EventMetadata](_metadata_v0_events_.eventmetadata.md) -*Defined in [type/Event.ts:158](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Event.ts#L158)* +*Defined in [type/Event.ts:158](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Event.ts#L158)* *__description__*: The [EventMetadata](_metadata_v0_events_.eventmetadata.md) with the documentation @@ -158,7 +158,7 @@ ___ getmethod(): `string` -*Defined in [type/Event.ts:165](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Event.ts#L165)* +*Defined in [type/Event.ts:165](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Event.ts#L165)* *__description__*: The method string identifying the event @@ -171,7 +171,7 @@ ___ getsection(): `string` -*Defined in [type/Event.ts:172](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Event.ts#L172)* +*Defined in [type/Event.ts:172](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Event.ts#L172)* *__description__*: The section string identifying the event @@ -184,7 +184,7 @@ ___ gettypeDef(): `Array`<[TypeDef](../modules/_types_.md#typedef)> -*Defined in [type/Event.ts:179](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Event.ts#L179)* +*Defined in [type/Event.ts:179](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Event.ts#L179)* *__description__*: The [TypeDef](../modules/_types_.md#typedef) for the event @@ -266,7 +266,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -309,7 +309,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -330,7 +330,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -405,7 +405,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -422,7 +422,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -439,7 +439,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -456,7 +456,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -473,7 +473,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -507,7 +507,7 @@ ___ ▸ **decodeEvent**(value?: *`Uint8Array`*): `object` \| `object` -*Defined in [type/Event.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Event.ts#L98)* +*Defined in [type/Event.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Event.ts#L98)* **Parameters:** @@ -524,7 +524,7 @@ ___ ▸ **injectMetadata**(metadata: *[MetadataV0](_metadata_v0_index_.metadatav0.md)*): `void` -*Defined in [type/Event.ts:122](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Event.ts#L122)* +*Defined in [type/Event.ts:122](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Event.ts#L122)* **Parameters:** @@ -543,7 +543,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_event_.eventdata.md b/docs/types/classes/_type_event_.eventdata.md index 6406e52239..e2ad7c6ae3 100644 --- a/docs/types/classes/_type_event_.eventdata.md +++ b/docs/types/classes/_type_event_.eventdata.md @@ -27,7 +27,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [type/Event.ts:28](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Event.ts#L28)* +*Defined in [type/Event.ts:28](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Event.ts#L28)* **Parameters:** @@ -70,7 +70,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L75)* +*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L75)* *__description__*: The types definition of the tuple @@ -85,7 +85,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/1c6a89b/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -100,7 +100,7 @@ getisEmpty(): `boolean` *Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L68)* *__description__*: Checks if the value is an empty value @@ -113,7 +113,7 @@ ___ getmeta(): [EventMetadata](_metadata_v0_events_.eventmetadata.md) -*Defined in [type/Event.ts:42](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Event.ts#L42)* +*Defined in [type/Event.ts:42](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Event.ts#L42)* *__description__*: The wrapped [EventMetadata](_metadata_v0_events_.eventmetadata.md) @@ -126,7 +126,7 @@ ___ getmethod(): `string` -*Defined in [type/Event.ts:49](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Event.ts#L49)* +*Defined in [type/Event.ts:49](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Event.ts#L49)* *__description__*: The method as a string @@ -139,7 +139,7 @@ ___ getsection(): `string` -*Defined in [type/Event.ts:56](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Event.ts#L56)* +*Defined in [type/Event.ts:56](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Event.ts#L56)* *__description__*: The section as a string @@ -152,7 +152,7 @@ ___ gettypeDef(): `Array`<[TypeDef](../modules/_types_.md#typedef)> -*Defined in [type/Event.ts:63](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Event.ts#L63)* +*Defined in [type/Event.ts:63](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Event.ts#L63)* *__description__*: The [TypeDef](../modules/_types_.md#typedef) for this event @@ -277,7 +277,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Compares the value of the input to see if there is a match @@ -345,7 +345,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L140)* +*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L140)* *__description__*: Filters the array with the callback @@ -765,7 +765,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L149)* +*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L149)* *__description__*: Maps the array with the callback @@ -1073,7 +1073,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1090,7 +1090,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Returns a hex string representation of the value @@ -1107,7 +1107,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L105)* +*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L105)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1141,7 +1141,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L114)* +*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L114)* *__description__*: Returns the string representation of the value @@ -1158,7 +1158,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L123)* +*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L123)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1215,7 +1215,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/1c6a89b/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_type_event_.eventindex.md b/docs/types/classes/_type_event_.eventindex.md index 17678bdc47..dddd50dee8 100644 --- a/docs/types/classes/_type_event_.eventindex.md +++ b/docs/types/classes/_type_event_.eventindex.md @@ -27,7 +27,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [type/Event.ts:74](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Event.ts#L74)* +*Defined in [type/Event.ts:74](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Event.ts#L74)* **Parameters:** @@ -115,7 +115,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -130,7 +130,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -147,7 +147,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -178,7 +178,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -233,7 +233,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -727,7 +727,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -751,7 +751,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -768,7 +768,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -802,7 +802,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -819,7 +819,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_eventrecord_.applyextrinsic.md b/docs/types/classes/_type_eventrecord_.applyextrinsic.md index 1d4841a101..857811f534 100644 --- a/docs/types/classes/_type_eventrecord_.applyextrinsic.md +++ b/docs/types/classes/_type_eventrecord_.applyextrinsic.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/U32.ts#L14)* +*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/U32.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -63,7 +63,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -203,7 +203,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -378,7 +378,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1542,7 +1542,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1583,7 +1583,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1602,7 +1602,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1655,7 +1655,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1701,7 +1701,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1905,7 +1905,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_type_eventrecord_.eventrecord.md b/docs/types/classes/_type_eventrecord_.eventrecord.md index 476e975dbc..273516c41b 100644 --- a/docs/types/classes/_type_eventrecord_.eventrecord.md +++ b/docs/types/classes/_type_eventrecord_.eventrecord.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/EventRecord.ts:61](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/EventRecord.ts#L61)* +*Defined in [type/EventRecord.ts:61](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/EventRecord.ts#L61)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -91,7 +91,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -104,7 +104,7 @@ ___ getevent(): [Event](_type_event_.event.md) -*Defined in [type/EventRecord.ts:72](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/EventRecord.ts#L72)* +*Defined in [type/EventRecord.ts:72](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/EventRecord.ts#L72)* *__description__*: The [Event](_type_event_.event.md) this record refers to @@ -119,7 +119,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -132,7 +132,7 @@ ___ getphase(): [Phase](_type_eventrecord_.phase.md) -*Defined in [type/EventRecord.ts:79](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/EventRecord.ts#L79)* +*Defined in [type/EventRecord.ts:79](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/EventRecord.ts#L79)* *__description__*: The [Phase](_type_eventrecord_.phase.md) where the event was generated @@ -214,7 +214,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -257,7 +257,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -278,7 +278,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -353,7 +353,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -370,7 +370,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -387,7 +387,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -404,7 +404,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -421,7 +421,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -457,7 +457,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_eventrecord_.finalization.md b/docs/types/classes/_type_eventrecord_.finalization.md index d04cb08063..813b14d5f3 100644 --- a/docs/types/classes/_type_eventrecord_.finalization.md +++ b/docs/types/classes/_type_eventrecord_.finalization.md @@ -24,7 +24,7 @@ getencodedLength(): `number` *Inherited from [Null](_primitive_null_.null.md).[encodedLength](_primitive_null_.null.md#encodedlength)* -*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L17)* +*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L17)* *__description__*: The length of the value when encoded as a Uint8Array @@ -39,7 +39,7 @@ getisEmpty(): `boolean` *Inherited from [Null](_primitive_null_.null.md).[isEmpty](_primitive_null_.null.md#isempty)* -*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L24)* +*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L24)* *__description__*: Checks if the value is an empty value (always true) @@ -59,7 +59,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[eq](_primitive_null_.null.md#eq)* -*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L31)* +*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L31)* *__description__*: Compares the value of the input to see if there is a match @@ -82,7 +82,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toHex](_primitive_null_.null.md#tohex)* -*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L38)* +*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L38)* *__description__*: Returns a hex string representation of the value @@ -99,7 +99,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toJSON](_primitive_null_.null.md#tojson)* -*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L45)* +*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L45)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -116,7 +116,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toString](_primitive_null_.null.md#tostring)* -*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L52)* +*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L52)* *__description__*: Returns the string representation of the value @@ -133,7 +133,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toU8a](_primitive_null_.null.md#tou8a)* -*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L60)* +*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L60)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_eventrecord_.phase.md b/docs/types/classes/_type_eventrecord_.phase.md index 19b998f315..c94ea791c9 100644 --- a/docs/types/classes/_type_eventrecord_.phase.md +++ b/docs/types/classes/_type_eventrecord_.phase.md @@ -24,7 +24,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [type/EventRecord.ts:32](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/EventRecord.ts#L32)* +*Defined in [type/EventRecord.ts:32](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/EventRecord.ts#L32)* **Parameters:** @@ -45,7 +45,7 @@ ___ getasApplyExtrinsic(): [ApplyExtrinsic](_type_eventrecord_.applyextrinsic.md) -*Defined in [type/EventRecord.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/EventRecord.ts#L43)* +*Defined in [type/EventRecord.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/EventRecord.ts#L43)* *__description__*: Returns the item as a [ApplyExtrinsic](_type_eventrecord_.applyextrinsic.md) @@ -58,7 +58,7 @@ ___ getasFinalization(): [Finalization](_type_eventrecord_.finalization.md) -*Defined in [type/EventRecord.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/EventRecord.ts#L50)* +*Defined in [type/EventRecord.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/EventRecord.ts#L50)* *__description__*: Returns the item as a [Finalization](_type_eventrecord_.finalization.md) @@ -73,7 +73,7 @@ getencodedLength(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L114)* +*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L114)* *__description__*: The length of the value when encoded as a Uint8Array @@ -88,7 +88,7 @@ getindex(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L121)* +*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L121)* *__description__*: The index of the metadata value @@ -103,7 +103,7 @@ getisEmpty(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isEmpty](_codec_enumtype_.enumtype.md#isempty)* -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L128)* +*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L128)* *__description__*: Checks if the value is an empty value @@ -118,7 +118,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L135)* +*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L135)* *__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type @@ -133,7 +133,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L142)* +*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L142)* *__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type (deprecated, use isNone) @@ -148,7 +148,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L149)* +*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L149)* *__description__*: The name of the type this enum value represents @@ -163,7 +163,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:156](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L156)* +*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L156)* *__description__*: The value of the enum @@ -183,7 +183,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* -*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L163)* +*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L163)* *__description__*: Compares the value of the input to see if there is a match @@ -206,7 +206,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L176)* +*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L176)* *__description__*: Returns a hex string representation of the value @@ -223,7 +223,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L183)* +*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L183)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -238,7 +238,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L192)* +*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L192)* *__description__*: Returns the number representation for the value @@ -255,7 +255,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [codec/EnumType.ts:199](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L199)* +*Defined in [codec/EnumType.ts:199](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L199)* *__description__*: Returns the string representation of the value @@ -272,7 +272,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L209)* +*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -293,7 +293,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L101)* +*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L101)* **Type parameters:** diff --git a/docs/types/classes/_type_extrinsic_.extrinsic.md b/docs/types/classes/_type_extrinsic_.extrinsic.md index f9725e3b18..6857b49652 100644 --- a/docs/types/classes/_type_extrinsic_.extrinsic.md +++ b/docs/types/classes/_type_extrinsic_.extrinsic.md @@ -36,7 +36,7 @@ Can be: *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/Extrinsic.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L36)* +*Defined in [type/Extrinsic.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L36)* **Parameters:** @@ -83,7 +83,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -96,7 +96,7 @@ ___ getargs(): `Array`<[Codec](../interfaces/_types_.codec.md)> -*Defined in [type/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L76)* +*Defined in [type/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L76)* *__description__*: The arguments passed to for the call, exposes args so it is compatible with [Method](_primitive_method_.method.md) @@ -109,7 +109,7 @@ ___ getcallIndex(): `Uint8Array` -*Defined in [type/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L83)* +*Defined in [type/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L83)* *__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method @@ -122,7 +122,7 @@ ___ getdata(): `Uint8Array` -*Defined in [type/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L90)* +*Defined in [type/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L90)* *__description__*: The actual data for the Method @@ -137,7 +137,7 @@ getencodedLength(): `number` *Overrides [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [type/Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L97)* +*Defined in [type/Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L97)* *__description__*: The length of the value when encoded as a Uint8Array @@ -150,7 +150,7 @@ ___ gethash(): [Hash](_type_hash_.hash.md) -*Defined in [type/Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L106)* +*Defined in [type/Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L106)* *__description__*: Convernience function, encodes the extrinsic and returns the actual hash @@ -165,7 +165,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -178,7 +178,7 @@ ___ getisSigned(): `boolean` -*Defined in [type/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L115)* +*Defined in [type/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L115)* *__description__*: `true` id the extrinsic is signed @@ -191,7 +191,7 @@ ___ getlength(): `number` -*Defined in [type/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L122)* +*Defined in [type/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L122)* *__description__*: The length of the encoded value @@ -204,7 +204,7 @@ ___ getmeta(): [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) -*Defined in [type/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L129)* +*Defined in [type/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L129)* *__description__*: The [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) that describes the extrinsic @@ -217,7 +217,7 @@ ___ getmethod(): [Method](_primitive_method_.method.md) -*Defined in [type/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L136)* +*Defined in [type/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L136)* *__description__*: The [Method](_primitive_method_.method.md) this extrinsic wraps @@ -230,7 +230,7 @@ ___ getsignature(): [ExtrinsicSignature](_type_extrinsicsignature_.extrinsicsignature.md) -*Defined in [type/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L143)* +*Defined in [type/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L143)* *__description__*: The [ExtrinsicSignature](_type_extrinsicsignature_.extrinsicsignature.md) @@ -261,7 +261,7 @@ ___ ▸ **addSignature**(signer: *[Address](_type_address_.address.md) \| `Uint8Array`*, signature: *`Uint8Array`*, nonce: *[AnyNumber](../modules/_types_.md#anynumber)*, era?: *[Uint8Array](_codec_u8a_.u8a.md#uint8array)*): [Extrinsic](_type_extrinsic_.extrinsic.md) -*Defined in [type/Extrinsic.ts:150](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L150)* +*Defined in [type/Extrinsic.ts:150](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L150)* *__description__*: Add an [ExtrinsicSignature](_type_extrinsicsignature_.extrinsicsignature.md) to the extrinsic (already generated) @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -377,7 +377,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -398,7 +398,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -471,7 +471,7 @@ ___ ▸ **sign**(account: *`KeyringPair`*, options: *[SignatureOptions](../modules/_types_.md#signatureoptions)*): [Extrinsic](_type_extrinsic_.extrinsic.md) -*Defined in [type/Extrinsic.ts:159](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L159)* +*Defined in [type/Extrinsic.ts:159](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L159)* *__description__*: Sign the extrinsic with a specific keypair @@ -493,7 +493,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -510,7 +510,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [type/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L168)* +*Defined in [type/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L168)* *__description__*: Returns a hex string representation of the value @@ -527,7 +527,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [type/Extrinsic.ts:175](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L175)* +*Defined in [type/Extrinsic.ts:175](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L175)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -544,7 +544,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -561,7 +561,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [type/Extrinsic.ts:183](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L183)* +*Defined in [type/Extrinsic.ts:183](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L183)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -595,7 +595,7 @@ ___ ▸ **decodeExtrinsic**(value: *`ExtrinsicValue` \| [AnyU8a](../modules/_types_.md#anyu8a) \| [Method](_primitive_method_.method.md)*): `ExtrinsicValue` \| `Array`<`number`> \| `Uint8Array` -*Defined in [type/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Extrinsic.ts#L44)* +*Defined in [type/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Extrinsic.ts#L44)* **Parameters:** @@ -614,7 +614,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_extrinsicera_.extrinsicera.md b/docs/types/classes/_type_extrinsicera_.extrinsicera.md index dd08beea44..726d80cbd6 100644 --- a/docs/types/classes/_type_extrinsicera_.extrinsicera.md +++ b/docs/types/classes/_type_extrinsicera_.extrinsicera.md @@ -27,7 +27,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [type/ExtrinsicEra.ts:16](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ExtrinsicEra.ts#L16)* +*Defined in [type/ExtrinsicEra.ts:16](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ExtrinsicEra.ts#L16)* **Parameters:** @@ -115,7 +115,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -130,7 +130,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -147,7 +147,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -218,7 +218,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -712,7 +712,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -736,7 +736,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -753,7 +753,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -787,7 +787,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -804,7 +804,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -838,7 +838,7 @@ ___ ▸ **decodeExtrinsicEra**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): `Uint8Array` -*Defined in [type/ExtrinsicEra.ts:23](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ExtrinsicEra.ts#L23)* +*Defined in [type/ExtrinsicEra.ts:23](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ExtrinsicEra.ts#L23)* **Parameters:** diff --git a/docs/types/classes/_type_extrinsics_.extrinsics.md b/docs/types/classes/_type_extrinsics_.extrinsics.md index 255ffd0101..c9fffe04f6 100644 --- a/docs/types/classes/_type_extrinsics_.extrinsics.md +++ b/docs/types/classes/_type_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/1c6a89b/packages/types/src/codec/Vector.ts#L22)* +*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/6eb859c/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:66](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L66)* +*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L66)* *__description__*: The type for the items @@ -69,7 +69,7 @@ getencodedLength(): `number` *Inherited from [Vector](_codec_vector_.vector.md).[encodedLength](_codec_vector_.vector.md#encodedlength)* -*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L73)* +*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L73)* *__description__*: The length of the value when encoded as a Uint8Array @@ -84,7 +84,7 @@ getisEmpty(): `boolean` *Inherited from [Vector](_codec_vector_.vector.md).[isEmpty](_codec_vector_.vector.md#isempty)* -*Defined in [codec/Vector.ts:59](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L59)* +*Defined in [codec/Vector.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L59)* *__description__*: Checks if the value is an empty value @@ -101,7 +101,7 @@ getlength(): `number` *Overrides Array.length* -*Defined in [codec/Vector.ts:82](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L82)* +*Defined in [codec/Vector.ts:82](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L82)* *__description__*: The length of the value @@ -226,7 +226,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[eq](_codec_vector_.vector.md#eq)* -*Defined in [codec/Vector.ts:90](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L90)* +*Defined in [codec/Vector.ts:90](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L90)* *__description__*: Compares the value of the input to see if there is a match @@ -294,7 +294,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Vector.ts:173](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L173)* +*Defined in [codec/Vector.ts:173](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L173)* *__description__*: Filters the array with the callback @@ -634,7 +634,7 @@ ___ *Overrides Array.indexOf* -*Defined in [codec/Vector.ts:97](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L97)* +*Defined in [codec/Vector.ts:97](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L97)* *__description__*: Finds the index of the value in the array @@ -715,7 +715,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Vector.ts:182](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L182)* +*Defined in [codec/Vector.ts:182](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L182)* *__description__*: Maps the array with the callback @@ -1023,7 +1023,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)* -*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L115)* +*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L115)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1040,7 +1040,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)* -*Defined in [codec/Vector.ts:122](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L122)* +*Defined in [codec/Vector.ts:122](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L122)* *__description__*: Returns a hex string representation of the value @@ -1057,7 +1057,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* -*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L129)* +*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L129)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1091,7 +1091,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Vector.ts:138](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L138)* +*Defined in [codec/Vector.ts:138](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L138)* *__description__*: Returns the string representation of the value @@ -1108,7 +1108,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* -*Defined in [codec/Vector.ts:151](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L151)* +*Defined in [codec/Vector.ts:151](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L151)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1165,7 +1165,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/1c6a89b/packages/types/src/codec/Vector.ts#L32)* +*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L32)* **Type parameters:** @@ -1188,7 +1188,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* -*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L48)* +*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L48)* **Type parameters:** diff --git a/docs/types/classes/_type_extrinsicsignature_.extrinsicsignature.md b/docs/types/classes/_type_extrinsicsignature_.extrinsicsignature.md index e046ac9cea..ca3eb8285c 100644 --- a/docs/types/classes/_type_extrinsicsignature_.extrinsicsignature.md +++ b/docs/types/classes/_type_extrinsicsignature_.extrinsicsignature.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/ExtrinsicSignature.ts:29](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ExtrinsicSignature.ts#L29)* +*Defined in [type/ExtrinsicSignature.ts:29](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ExtrinsicSignature.ts#L29)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -91,7 +91,7 @@ getencodedLength(): `number` *Overrides [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [type/ExtrinsicSignature.ts:66](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ExtrinsicSignature.ts#L66)* +*Defined in [type/ExtrinsicSignature.ts:66](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ExtrinsicSignature.ts#L66)* *__description__*: The length of the value when encoded as a Uint8Array @@ -104,7 +104,7 @@ ___ getera(): [ExtrinsicEra](_type_extrinsicera_.extrinsicera.md) -*Defined in [type/ExtrinsicSignature.ts:82](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ExtrinsicSignature.ts#L82)* +*Defined in [type/ExtrinsicSignature.ts:82](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ExtrinsicSignature.ts#L82)* *__description__*: The [ExtrinsicEra](_type_extrinsicera_.extrinsicera.md) (mortal or immortal) this signature applies to @@ -119,7 +119,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -132,7 +132,7 @@ ___ getisSigned(): `boolean` -*Defined in [type/ExtrinsicSignature.ts:75](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ExtrinsicSignature.ts#L75)* +*Defined in [type/ExtrinsicSignature.ts:75](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ExtrinsicSignature.ts#L75)* *__description__*: `true` if the signature is valid @@ -145,7 +145,7 @@ ___ getnonce(): [Nonce](_type_nonce_.nonce.md) -*Defined in [type/ExtrinsicSignature.ts:89](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ExtrinsicSignature.ts#L89)* +*Defined in [type/ExtrinsicSignature.ts:89](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ExtrinsicSignature.ts#L89)* *__description__*: The [Nonce](_type_nonce_.nonce.md) for the signature @@ -158,7 +158,7 @@ ___ getsignature(): [Signature](_type_signature_.signature.md) -*Defined in [type/ExtrinsicSignature.ts:96](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ExtrinsicSignature.ts#L96)* +*Defined in [type/ExtrinsicSignature.ts:96](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ExtrinsicSignature.ts#L96)* *__description__*: The actuall [Signature](_type_signature_.signature.md) hash @@ -171,7 +171,7 @@ ___ getsigner(): [Address](_type_address_.address.md) -*Defined in [type/ExtrinsicSignature.ts:103](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ExtrinsicSignature.ts#L103)* +*Defined in [type/ExtrinsicSignature.ts:103](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ExtrinsicSignature.ts#L103)* *__description__*: The [Address](_type_address_.address.md) that signed @@ -184,7 +184,7 @@ ___ getversion(): `number` -*Defined in [type/ExtrinsicSignature.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ExtrinsicSignature.ts#L110)* +*Defined in [type/ExtrinsicSignature.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ExtrinsicSignature.ts#L110)* *__description__*: The encoded version for the signature @@ -215,7 +215,7 @@ ___ ▸ **addSignature**(_signer: *[Address](_type_address_.address.md) \| `Uint8Array`*, _signature: *`Uint8Array`*, _nonce: *[AnyNumber](../modules/_types_.md#anynumber)*, _era?: *`Uint8Array`*): [ExtrinsicSignature](_type_extrinsicsignature_.extrinsicsignature.md) -*Defined in [type/ExtrinsicSignature.ts:131](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ExtrinsicSignature.ts#L131)* +*Defined in [type/ExtrinsicSignature.ts:131](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ExtrinsicSignature.ts#L131)* *__description__*: Adds a raw signature @@ -288,7 +288,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -331,7 +331,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -352,7 +352,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -425,7 +425,7 @@ ___ ▸ **sign**(method: *[Method](_primitive_method_.method.md)*, account: *`KeyringPair`*, __namedParameters: *`object`*): [ExtrinsicSignature](_type_extrinsicsignature_.extrinsicsignature.md) -*Defined in [type/ExtrinsicSignature.ts:143](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ExtrinsicSignature.ts#L143)* +*Defined in [type/ExtrinsicSignature.ts:143](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ExtrinsicSignature.ts#L143)* *__description__*: Generate a payload and pplies the signature from a keypair @@ -448,7 +448,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -465,7 +465,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -482,7 +482,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -499,7 +499,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -516,7 +516,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [type/ExtrinsicSignature.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ExtrinsicSignature.ts#L160)* +*Defined in [type/ExtrinsicSignature.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ExtrinsicSignature.ts#L160)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -550,7 +550,7 @@ ___ ▸ **decodeExtrinsicSignature**(value?: *[Uint8Array](_codec_u8a_.u8a.md#uint8array)*): `object` \| `Uint8Array` -*Defined in [type/ExtrinsicSignature.ts:46](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ExtrinsicSignature.ts#L46)* +*Defined in [type/ExtrinsicSignature.ts:46](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ExtrinsicSignature.ts#L46)* **Parameters:** @@ -569,7 +569,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_extrinsicstatus_.broadcast.md b/docs/types/classes/_type_extrinsicstatus_.broadcast.md index d77524f483..8ef6515e69 100644 --- a/docs/types/classes/_type_extrinsicstatus_.broadcast.md +++ b/docs/types/classes/_type_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/1c6a89b/packages/types/src/codec/Vector.ts#L22)* +*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/6eb859c/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:66](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L66)* +*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L66)* *__description__*: The type for the items @@ -67,7 +67,7 @@ getencodedLength(): `number` *Inherited from [Vector](_codec_vector_.vector.md).[encodedLength](_codec_vector_.vector.md#encodedlength)* -*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L73)* +*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L73)* *__description__*: The length of the value when encoded as a Uint8Array @@ -82,7 +82,7 @@ getisEmpty(): `boolean` *Inherited from [Vector](_codec_vector_.vector.md).[isEmpty](_codec_vector_.vector.md#isempty)* -*Defined in [codec/Vector.ts:59](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L59)* +*Defined in [codec/Vector.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L59)* *__description__*: Checks if the value is an empty value @@ -99,7 +99,7 @@ getlength(): `number` *Overrides Array.length* -*Defined in [codec/Vector.ts:82](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L82)* +*Defined in [codec/Vector.ts:82](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L82)* *__description__*: The length of the value @@ -224,7 +224,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[eq](_codec_vector_.vector.md#eq)* -*Defined in [codec/Vector.ts:90](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L90)* +*Defined in [codec/Vector.ts:90](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L90)* *__description__*: Compares the value of the input to see if there is a match @@ -292,7 +292,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Vector.ts:173](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L173)* +*Defined in [codec/Vector.ts:173](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L173)* *__description__*: Filters the array with the callback @@ -632,7 +632,7 @@ ___ *Overrides Array.indexOf* -*Defined in [codec/Vector.ts:97](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L97)* +*Defined in [codec/Vector.ts:97](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L97)* *__description__*: Finds the index of the value in the array @@ -713,7 +713,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Vector.ts:182](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L182)* +*Defined in [codec/Vector.ts:182](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L182)* *__description__*: Maps the array with the callback @@ -1021,7 +1021,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)* -*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L115)* +*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L115)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1038,7 +1038,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)* -*Defined in [codec/Vector.ts:122](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L122)* +*Defined in [codec/Vector.ts:122](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L122)* *__description__*: Returns a hex string representation of the value @@ -1055,7 +1055,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* -*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L129)* +*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L129)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1089,7 +1089,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Vector.ts:138](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L138)* +*Defined in [codec/Vector.ts:138](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L138)* *__description__*: Returns the string representation of the value @@ -1106,7 +1106,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* -*Defined in [codec/Vector.ts:151](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L151)* +*Defined in [codec/Vector.ts:151](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L151)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1163,7 +1163,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/1c6a89b/packages/types/src/codec/Vector.ts#L32)* +*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L32)* **Type parameters:** @@ -1186,7 +1186,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* -*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L48)* +*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L48)* **Type parameters:** diff --git a/docs/types/classes/_type_extrinsicstatus_.dropped.md b/docs/types/classes/_type_extrinsicstatus_.dropped.md index 897c2bda7a..a5167b65e9 100644 --- a/docs/types/classes/_type_extrinsicstatus_.dropped.md +++ b/docs/types/classes/_type_extrinsicstatus_.dropped.md @@ -24,7 +24,7 @@ getencodedLength(): `number` *Inherited from [Null](_primitive_null_.null.md).[encodedLength](_primitive_null_.null.md#encodedlength)* -*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L17)* +*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L17)* *__description__*: The length of the value when encoded as a Uint8Array @@ -39,7 +39,7 @@ getisEmpty(): `boolean` *Inherited from [Null](_primitive_null_.null.md).[isEmpty](_primitive_null_.null.md#isempty)* -*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L24)* +*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L24)* *__description__*: Checks if the value is an empty value (always true) @@ -59,7 +59,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[eq](_primitive_null_.null.md#eq)* -*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L31)* +*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L31)* *__description__*: Compares the value of the input to see if there is a match @@ -82,7 +82,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toHex](_primitive_null_.null.md#tohex)* -*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L38)* +*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L38)* *__description__*: Returns a hex string representation of the value @@ -99,7 +99,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toJSON](_primitive_null_.null.md#tojson)* -*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L45)* +*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L45)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -116,7 +116,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toString](_primitive_null_.null.md#tostring)* -*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L52)* +*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L52)* *__description__*: Returns the string representation of the value @@ -133,7 +133,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toU8a](_primitive_null_.null.md#tou8a)* -*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L60)* +*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L60)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_extrinsicstatus_.extrinsicstatus.md b/docs/types/classes/_type_extrinsicstatus_.extrinsicstatus.md index 87560e81ed..0ffcbf88ff 100644 --- a/docs/types/classes/_type_extrinsicstatus_.extrinsicstatus.md +++ b/docs/types/classes/_type_extrinsicstatus_.extrinsicstatus.md @@ -24,7 +24,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [type/ExtrinsicStatus.ts:72](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ExtrinsicStatus.ts#L72)* +*Defined in [type/ExtrinsicStatus.ts:72](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ExtrinsicStatus.ts#L72)* **Parameters:** @@ -45,7 +45,7 @@ ___ getasBroadcast(): [Broadcast](_type_extrinsicstatus_.broadcast.md) -*Defined in [type/ExtrinsicStatus.ts:88](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ExtrinsicStatus.ts#L88)* +*Defined in [type/ExtrinsicStatus.ts:88](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ExtrinsicStatus.ts#L88)* *__description__*: Returns the item as a [Broadcast](_type_extrinsicstatus_.broadcast.md) @@ -58,7 +58,7 @@ ___ getasDropped(): [Dropped](_type_extrinsicstatus_.dropped.md) -*Defined in [type/ExtrinsicStatus.ts:95](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ExtrinsicStatus.ts#L95)* +*Defined in [type/ExtrinsicStatus.ts:95](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ExtrinsicStatus.ts#L95)* *__description__*: Returns the item as a [Dropped](_type_extrinsicstatus_.dropped.md) @@ -71,7 +71,7 @@ ___ getasFinalised(): [Finalised](_type_extrinsicstatus_.finalised.md) -*Defined in [type/ExtrinsicStatus.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ExtrinsicStatus.ts#L102)* +*Defined in [type/ExtrinsicStatus.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ExtrinsicStatus.ts#L102)* *__description__*: Returns the item as a [Finalised](_type_extrinsicstatus_.finalised.md) @@ -84,7 +84,7 @@ ___ getasFuture(): [Future](_type_extrinsicstatus_.future.md) -*Defined in [type/ExtrinsicStatus.ts:109](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ExtrinsicStatus.ts#L109)* +*Defined in [type/ExtrinsicStatus.ts:109](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ExtrinsicStatus.ts#L109)* *__description__*: Returns the item as a [Future](_type_extrinsicstatus_.future.md) @@ -97,7 +97,7 @@ ___ getasInvalid(): [Invalid](_type_extrinsicstatus_.invalid.md) -*Defined in [type/ExtrinsicStatus.ts:116](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ExtrinsicStatus.ts#L116)* +*Defined in [type/ExtrinsicStatus.ts:116](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ExtrinsicStatus.ts#L116)* *__description__*: Returns the item as a [Invalid](_type_extrinsicstatus_.invalid.md) @@ -110,7 +110,7 @@ ___ getasReady(): [Ready](_type_extrinsicstatus_.ready.md) -*Defined in [type/ExtrinsicStatus.ts:123](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ExtrinsicStatus.ts#L123)* +*Defined in [type/ExtrinsicStatus.ts:123](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ExtrinsicStatus.ts#L123)* *__description__*: Returns the item as a [Ready](_type_extrinsicstatus_.ready.md) @@ -123,7 +123,7 @@ ___ getasUsurped(): [Usurped](_type_extrinsicstatus_.usurped.md) -*Defined in [type/ExtrinsicStatus.ts:130](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ExtrinsicStatus.ts#L130)* +*Defined in [type/ExtrinsicStatus.ts:130](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ExtrinsicStatus.ts#L130)* *__description__*: Returns the item as a [Usurped](_type_extrinsicstatus_.usurped.md) @@ -138,7 +138,7 @@ getencodedLength(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L114)* +*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L114)* *__description__*: The length of the value when encoded as a Uint8Array @@ -153,7 +153,7 @@ getindex(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L121)* +*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L121)* *__description__*: The index of the metadata value @@ -168,7 +168,7 @@ getisEmpty(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isEmpty](_codec_enumtype_.enumtype.md#isempty)* -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L128)* +*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L128)* *__description__*: Checks if the value is an empty value @@ -183,7 +183,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L135)* +*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L135)* *__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type @@ -198,7 +198,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L142)* +*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L142)* *__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type (deprecated, use isNone) @@ -213,7 +213,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L149)* +*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L149)* *__description__*: The name of the type this enum value represents @@ -228,7 +228,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:156](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L156)* +*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L156)* *__description__*: The value of the enum @@ -248,7 +248,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* -*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L163)* +*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L163)* *__description__*: Compares the value of the input to see if there is a match @@ -271,7 +271,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L176)* +*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L176)* *__description__*: Returns a hex string representation of the value @@ -288,7 +288,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L183)* +*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L183)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -303,7 +303,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L192)* +*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L192)* *__description__*: Returns the number representation for the value @@ -320,7 +320,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [codec/EnumType.ts:199](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L199)* +*Defined in [codec/EnumType.ts:199](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L199)* *__description__*: Returns the string representation of the value @@ -337,7 +337,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L209)* +*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -358,7 +358,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L101)* +*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L101)* **Type parameters:** diff --git a/docs/types/classes/_type_extrinsicstatus_.finalised.md b/docs/types/classes/_type_extrinsicstatus_.finalised.md index 52fafc59ca..24909db520 100644 --- a/docs/types/classes/_type_extrinsicstatus_.finalised.md +++ b/docs/types/classes/_type_extrinsicstatus_.finalised.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [primitive/H256.ts:15](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/H256.ts#L15)* +*Defined in [primitive/H256.ts:15](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/H256.ts#L15)* **Parameters:** @@ -117,7 +117,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -132,7 +132,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -149,7 +149,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -180,7 +180,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -235,7 +235,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -729,7 +729,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -753,7 +753,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -770,7 +770,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -804,7 +804,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -821,7 +821,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_extrinsicstatus_.future.md b/docs/types/classes/_type_extrinsicstatus_.future.md index 15032b68db..1e60b96595 100644 --- a/docs/types/classes/_type_extrinsicstatus_.future.md +++ b/docs/types/classes/_type_extrinsicstatus_.future.md @@ -24,7 +24,7 @@ getencodedLength(): `number` *Inherited from [Null](_primitive_null_.null.md).[encodedLength](_primitive_null_.null.md#encodedlength)* -*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L17)* +*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L17)* *__description__*: The length of the value when encoded as a Uint8Array @@ -39,7 +39,7 @@ getisEmpty(): `boolean` *Inherited from [Null](_primitive_null_.null.md).[isEmpty](_primitive_null_.null.md#isempty)* -*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L24)* +*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L24)* *__description__*: Checks if the value is an empty value (always true) @@ -59,7 +59,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[eq](_primitive_null_.null.md#eq)* -*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L31)* +*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L31)* *__description__*: Compares the value of the input to see if there is a match @@ -82,7 +82,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toHex](_primitive_null_.null.md#tohex)* -*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L38)* +*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L38)* *__description__*: Returns a hex string representation of the value @@ -99,7 +99,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toJSON](_primitive_null_.null.md#tojson)* -*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L45)* +*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L45)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -116,7 +116,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toString](_primitive_null_.null.md#tostring)* -*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L52)* +*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L52)* *__description__*: Returns the string representation of the value @@ -133,7 +133,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toU8a](_primitive_null_.null.md#tou8a)* -*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L60)* +*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L60)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_extrinsicstatus_.invalid.md b/docs/types/classes/_type_extrinsicstatus_.invalid.md index 05c3c9a803..e8af37e441 100644 --- a/docs/types/classes/_type_extrinsicstatus_.invalid.md +++ b/docs/types/classes/_type_extrinsicstatus_.invalid.md @@ -24,7 +24,7 @@ getencodedLength(): `number` *Inherited from [Null](_primitive_null_.null.md).[encodedLength](_primitive_null_.null.md#encodedlength)* -*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L17)* +*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L17)* *__description__*: The length of the value when encoded as a Uint8Array @@ -39,7 +39,7 @@ getisEmpty(): `boolean` *Inherited from [Null](_primitive_null_.null.md).[isEmpty](_primitive_null_.null.md#isempty)* -*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L24)* +*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L24)* *__description__*: Checks if the value is an empty value (always true) @@ -59,7 +59,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[eq](_primitive_null_.null.md#eq)* -*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L31)* +*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L31)* *__description__*: Compares the value of the input to see if there is a match @@ -82,7 +82,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toHex](_primitive_null_.null.md#tohex)* -*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L38)* +*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L38)* *__description__*: Returns a hex string representation of the value @@ -99,7 +99,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toJSON](_primitive_null_.null.md#tojson)* -*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L45)* +*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L45)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -116,7 +116,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toString](_primitive_null_.null.md#tostring)* -*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L52)* +*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L52)* *__description__*: Returns the string representation of the value @@ -133,7 +133,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toU8a](_primitive_null_.null.md#tou8a)* -*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L60)* +*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L60)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_extrinsicstatus_.ready.md b/docs/types/classes/_type_extrinsicstatus_.ready.md index 213a522ac3..3af1adf583 100644 --- a/docs/types/classes/_type_extrinsicstatus_.ready.md +++ b/docs/types/classes/_type_extrinsicstatus_.ready.md @@ -24,7 +24,7 @@ getencodedLength(): `number` *Inherited from [Null](_primitive_null_.null.md).[encodedLength](_primitive_null_.null.md#encodedlength)* -*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L17)* +*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L17)* *__description__*: The length of the value when encoded as a Uint8Array @@ -39,7 +39,7 @@ getisEmpty(): `boolean` *Inherited from [Null](_primitive_null_.null.md).[isEmpty](_primitive_null_.null.md#isempty)* -*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L24)* +*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L24)* *__description__*: Checks if the value is an empty value (always true) @@ -59,7 +59,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[eq](_primitive_null_.null.md#eq)* -*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L31)* +*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L31)* *__description__*: Compares the value of the input to see if there is a match @@ -82,7 +82,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toHex](_primitive_null_.null.md#tohex)* -*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L38)* +*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L38)* *__description__*: Returns a hex string representation of the value @@ -99,7 +99,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toJSON](_primitive_null_.null.md#tojson)* -*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L45)* +*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L45)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -116,7 +116,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toString](_primitive_null_.null.md#tostring)* -*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L52)* +*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L52)* *__description__*: Returns the string representation of the value @@ -133,7 +133,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toU8a](_primitive_null_.null.md#tou8a)* -*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L60)* +*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L60)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_extrinsicstatus_.usurped.md b/docs/types/classes/_type_extrinsicstatus_.usurped.md index 3b6b135c82..59227e2992 100644 --- a/docs/types/classes/_type_extrinsicstatus_.usurped.md +++ b/docs/types/classes/_type_extrinsicstatus_.usurped.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [primitive/H256.ts:15](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/H256.ts#L15)* +*Defined in [primitive/H256.ts:15](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/H256.ts#L15)* **Parameters:** @@ -117,7 +117,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -132,7 +132,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -149,7 +149,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -180,7 +180,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -235,7 +235,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -729,7 +729,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -753,7 +753,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -770,7 +770,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -804,7 +804,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -821,7 +821,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_gas_.gas.md b/docs/types/classes/_type_gas_.gas.md index 835af955bf..bfd49959bf 100644 --- a/docs/types/classes/_type_gas_.gas.md +++ b/docs/types/classes/_type_gas_.gas.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [primitive/U64.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/U64.ts#L14)* +*Defined in [primitive/U64.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/U64.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -63,7 +63,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -203,7 +203,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -378,7 +378,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1542,7 +1542,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1583,7 +1583,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1602,7 +1602,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1655,7 +1655,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1701,7 +1701,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1905,7 +1905,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_type_hash_.hash.md b/docs/types/classes/_type_hash_.hash.md index ade794ff76..dd6ba27f55 100644 --- a/docs/types/classes/_type_hash_.hash.md +++ b/docs/types/classes/_type_hash_.hash.md @@ -39,7 +39,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [primitive/H256.ts:15](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/H256.ts#L15)* +*Defined in [primitive/H256.ts:15](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/H256.ts#L15)* **Parameters:** @@ -127,7 +127,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/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -142,7 +142,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -159,7 +159,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -190,7 +190,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -245,7 +245,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -739,7 +739,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -763,7 +763,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -780,7 +780,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -814,7 +814,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -831,7 +831,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_header_.header.md b/docs/types/classes/_type_header_.header.md index 77e58072e3..24203185aa 100644 --- a/docs/types/classes/_type_header_.header.md +++ b/docs/types/classes/_type_header_.header.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/Header.ts:30](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Header.ts#L30)* +*Defined in [type/Header.ts:30](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Header.ts#L30)* **Parameters:** @@ -78,7 +78,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -91,7 +91,7 @@ ___ getblockNumber(): [BlockNumber](_type_blocknumber_.blocknumber.md) -*Defined in [type/Header.ts:44](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Header.ts#L44)* +*Defined in [type/Header.ts:44](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Header.ts#L44)* *__description__*: The wrapped [BlockNumber](_type_blocknumber_.blocknumber.md) @@ -104,7 +104,7 @@ ___ getdigest(): [Digest](_type_digest_.digest.md) -*Defined in [type/Header.ts:51](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Header.ts#L51)* +*Defined in [type/Header.ts:51](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Header.ts#L51)* *__description__*: The wrapped [Digest](_type_digest_.digest.md) @@ -119,7 +119,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -132,7 +132,7 @@ ___ getextrinsicsRoot(): [Hash](_type_hash_.hash.md) -*Defined in [type/Header.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Header.ts#L58)* +*Defined in [type/Header.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Header.ts#L58)* *__description__*: The wrapped extrisics root as a [Hash](_type_hash_.hash.md) @@ -145,7 +145,7 @@ ___ gethash(): [Hash](_type_hash_.hash.md) -*Defined in [type/Header.ts:65](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Header.ts#L65)* +*Defined in [type/Header.ts:65](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Header.ts#L65)* *__description__*: Convenience method, encodes the header and calculates the [Hash](_type_hash_.hash.md) @@ -160,7 +160,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -173,7 +173,7 @@ ___ getparentHash(): [Hash](_type_hash_.hash.md) -*Defined in [type/Header.ts:74](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Header.ts#L74)* +*Defined in [type/Header.ts:74](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Header.ts#L74)* *__description__*: The wrapped parent as a [Hash](_type_hash_.hash.md) @@ -186,7 +186,7 @@ ___ getstateRoot(): [Hash](_type_hash_.hash.md) -*Defined in [type/Header.ts:81](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Header.ts#L81)* +*Defined in [type/Header.ts:81](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Header.ts#L81)* *__description__*: The wrapped state root as a [Hash](_type_hash_.hash.md) @@ -268,7 +268,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -311,7 +311,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -332,7 +332,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -407,7 +407,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -424,7 +424,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -441,7 +441,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -458,7 +458,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -475,7 +475,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -511,7 +511,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_header_.headerextended.md b/docs/types/classes/_type_header_.headerextended.md index 137f448d2c..6bd2330a42 100644 --- a/docs/types/classes/_type_header_.headerextended.md +++ b/docs/types/classes/_type_header_.headerextended.md @@ -29,7 +29,7 @@ *Overrides [Header](_type_header_.header.md).[constructor](_type_header_.header.md#constructor)* -*Defined in [type/Header.ts:92](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Header.ts#L92)* +*Defined in [type/Header.ts:92](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Header.ts#L92)* **Parameters:** @@ -77,7 +77,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -90,7 +90,7 @@ ___ getauthor(): [AccountId](_type_accountid_.accountid.md) \| `undefined` -*Defined in [type/Header.ts:107](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Header.ts#L107)* +*Defined in [type/Header.ts:107](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Header.ts#L107)* *__description__*: Convenience method, returns the author for the block @@ -105,7 +105,7 @@ getblockNumber(): [BlockNumber](_type_blocknumber_.blocknumber.md) *Inherited from [Header](_type_header_.header.md).[blockNumber](_type_header_.header.md#blocknumber)* -*Defined in [type/Header.ts:44](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Header.ts#L44)* +*Defined in [type/Header.ts:44](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Header.ts#L44)* *__description__*: The wrapped [BlockNumber](_type_blocknumber_.blocknumber.md) @@ -120,7 +120,7 @@ getdigest(): [Digest](_type_digest_.digest.md) *Inherited from [Header](_type_header_.header.md).[digest](_type_header_.header.md#digest)* -*Defined in [type/Header.ts:51](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Header.ts#L51)* +*Defined in [type/Header.ts:51](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Header.ts#L51)* *__description__*: The wrapped [Digest](_type_digest_.digest.md) @@ -135,7 +135,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -150,7 +150,7 @@ getextrinsicsRoot(): [Hash](_type_hash_.hash.md) *Inherited from [Header](_type_header_.header.md).[extrinsicsRoot](_type_header_.header.md#extrinsicsroot)* -*Defined in [type/Header.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Header.ts#L58)* +*Defined in [type/Header.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Header.ts#L58)* *__description__*: The wrapped extrisics root as a [Hash](_type_hash_.hash.md) @@ -165,7 +165,7 @@ gethash(): [Hash](_type_hash_.hash.md) *Inherited from [Header](_type_header_.header.md).[hash](_type_header_.header.md#hash)* -*Defined in [type/Header.ts:65](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Header.ts#L65)* +*Defined in [type/Header.ts:65](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Header.ts#L65)* *__description__*: Convenience method, encodes the header and calculates the [Hash](_type_hash_.hash.md) @@ -180,7 +180,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -195,7 +195,7 @@ getparentHash(): [Hash](_type_hash_.hash.md) *Inherited from [Header](_type_header_.header.md).[parentHash](_type_header_.header.md#parenthash)* -*Defined in [type/Header.ts:74](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Header.ts#L74)* +*Defined in [type/Header.ts:74](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Header.ts#L74)* *__description__*: The wrapped parent as a [Hash](_type_hash_.hash.md) @@ -210,7 +210,7 @@ getstateRoot(): [Hash](_type_hash_.hash.md) *Inherited from [Header](_type_header_.header.md).[stateRoot](_type_header_.header.md#stateroot)* -*Defined in [type/Header.ts:81](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Header.ts#L81)* +*Defined in [type/Header.ts:81](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Header.ts#L81)* *__description__*: The wrapped state root as a [Hash](_type_hash_.hash.md) @@ -292,7 +292,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -335,7 +335,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -356,7 +356,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -431,7 +431,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -448,7 +448,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -465,7 +465,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -482,7 +482,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -499,7 +499,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -535,7 +535,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_health_.health.md b/docs/types/classes/_type_health_.health.md index 1dfc32b474..9723077cfd 100644 --- a/docs/types/classes/_type_health_.health.md +++ b/docs/types/classes/_type_health_.health.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/Health.ts:19](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Health.ts#L19)* +*Defined in [type/Health.ts:19](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Health.ts#L19)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -91,7 +91,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -106,7 +106,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -119,7 +119,7 @@ ___ getisSyncing(): [Bool](_primitive_bool_.bool.md) -*Defined in [type/Health.ts:31](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Health.ts#L31)* +*Defined in [type/Health.ts:31](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Health.ts#L31)* *__description__*: The sync status @@ -132,7 +132,7 @@ ___ getpeers(): [USize](_primitive_usize_.usize.md) -*Defined in [type/Health.ts:38](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Health.ts#L38)* +*Defined in [type/Health.ts:38](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Health.ts#L38)* *__description__*: The numbers of peers as [U32](_primitive_u32_.u32.md) @@ -145,7 +145,7 @@ ___ getshouldHavePeers(): [Bool](_primitive_bool_.bool.md) -*Defined in [type/Health.ts:45](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Health.ts#L45)* +*Defined in [type/Health.ts:45](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Health.ts#L45)* *__description__*: Should this node have peers (not active on --dev) @@ -227,7 +227,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -270,7 +270,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -291,7 +291,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -383,7 +383,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -400,7 +400,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -417,7 +417,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -434,7 +434,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -470,7 +470,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_inherentofflinereport_.inherentofflinereport.md b/docs/types/classes/_type_inherentofflinereport_.inherentofflinereport.md index 0288ae68eb..f2bae34e1f 100644 --- a/docs/types/classes/_type_inherentofflinereport_.inherentofflinereport.md +++ b/docs/types/classes/_type_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/1c6a89b/packages/types/src/codec/Tuple.ts#L22)* +*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L22)* **Parameters:** @@ -66,7 +66,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L75)* +*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L75)* *__description__*: The types definition of the tuple @@ -81,7 +81,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/1c6a89b/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -96,7 +96,7 @@ getisEmpty(): `boolean` *Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L68)* *__description__*: Checks if the value is an empty value @@ -221,7 +221,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Compares the value of the input to see if there is a match @@ -289,7 +289,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L140)* +*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L140)* *__description__*: Filters the array with the callback @@ -709,7 +709,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L149)* +*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L149)* *__description__*: Maps the array with the callback @@ -1017,7 +1017,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1034,7 +1034,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Returns a hex string representation of the value @@ -1051,7 +1051,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L105)* +*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L105)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1085,7 +1085,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L114)* +*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L114)* *__description__*: Returns the string representation of the value @@ -1102,7 +1102,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L123)* +*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L123)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1159,7 +1159,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/1c6a89b/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_type_justification_.justification.md b/docs/types/classes/_type_justification_.justification.md index 1d6c36fe91..13a3eee752 100644 --- a/docs/types/classes/_type_justification_.justification.md +++ b/docs/types/classes/_type_justification_.justification.md @@ -29,7 +29,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [primitive/Bytes.ts:18](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bytes.ts#L18)* +*Defined in [primitive/Bytes.ts:18](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bytes.ts#L18)* **Parameters:** @@ -119,7 +119,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [primitive/Bytes.ts:61](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bytes.ts#L61)* +*Defined in [primitive/Bytes.ts:61](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bytes.ts#L61)* *__description__*: The length of the value when encoded as a Uint8Array @@ -134,7 +134,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -151,7 +151,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -222,7 +222,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -716,7 +716,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -740,7 +740,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -757,7 +757,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -791,7 +791,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -810,7 +810,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [primitive/Bytes.ts:69](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Bytes.ts#L69)* +*Defined in [primitive/Bytes.ts:69](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Bytes.ts#L69)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_justification_.rhdjustification.md b/docs/types/classes/_type_justification_.rhdjustification.md index dafa046807..50a440c1a6 100644 --- a/docs/types/classes/_type_justification_.rhdjustification.md +++ b/docs/types/classes/_type_justification_.rhdjustification.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/Justification.ts:33](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Justification.ts#L33)* +*Defined in [type/Justification.ts:33](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Justification.ts#L33)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -91,7 +91,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -104,7 +104,7 @@ ___ gethash(): [Hash](_type_hash_.hash.md) -*Defined in [type/Justification.ts:47](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Justification.ts#L47)* +*Defined in [type/Justification.ts:47](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Justification.ts#L47)* *__description__*: The justification [Hash](_type_hash_.hash.md) @@ -119,7 +119,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -132,7 +132,7 @@ ___ getroundNumber(): [U32](_primitive_u32_.u32.md) -*Defined in [type/Justification.ts:54](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Justification.ts#L54)* +*Defined in [type/Justification.ts:54](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Justification.ts#L54)* *__description__*: The round this justification wraps as a [U32](_primitive_u32_.u32.md) @@ -145,7 +145,7 @@ ___ getsignatures(): [Vector](_codec_vector_.vector.md)<[BftAuthoritySignature](_type_bft_.bftauthoritysignature.md)> -*Defined in [type/Justification.ts:61](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Justification.ts#L61)* +*Defined in [type/Justification.ts:61](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Justification.ts#L61)* *__description__*: The [BftAuthoritySignature](_type_bft_.bftauthoritysignature.md) array @@ -227,7 +227,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -270,7 +270,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -291,7 +291,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -383,7 +383,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -400,7 +400,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -417,7 +417,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -434,7 +434,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -470,7 +470,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_keyvalue_.keyvalue.md b/docs/types/classes/_type_keyvalue_.keyvalue.md index 2f642391cf..d88d2b8fdd 100644 --- a/docs/types/classes/_type_keyvalue_.keyvalue.md +++ b/docs/types/classes/_type_keyvalue_.keyvalue.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/KeyValue.ts:26](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/KeyValue.ts#L26)* +*Defined in [type/KeyValue.ts:26](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/KeyValue.ts#L26)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -91,7 +91,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -106,7 +106,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -119,7 +119,7 @@ ___ getkey(): [StorageKey](_primitive_storagekey_.storagekey.md) -*Defined in [type/KeyValue.ts:37](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/KeyValue.ts#L37)* +*Defined in [type/KeyValue.ts:37](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/KeyValue.ts#L37)* *__description__*: The [StorageKey](_primitive_storagekey_.storagekey.md) @@ -132,7 +132,7 @@ ___ getvalue(): [StorageData](_primitive_storagedata_.storagedata.md) -*Defined in [type/KeyValue.ts:44](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/KeyValue.ts#L44)* +*Defined in [type/KeyValue.ts:44](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/KeyValue.ts#L44)* *__description__*: The [StorageData](_primitive_storagedata_.storagedata.md) @@ -214,7 +214,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -257,7 +257,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -278,7 +278,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -353,7 +353,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -370,7 +370,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -387,7 +387,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -404,7 +404,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -421,7 +421,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -457,7 +457,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_keyvalue_.keyvalueoption.md b/docs/types/classes/_type_keyvalue_.keyvalueoption.md index 812fcd900a..56b00727a8 100644 --- a/docs/types/classes/_type_keyvalue_.keyvalueoption.md +++ b/docs/types/classes/_type_keyvalue_.keyvalueoption.md @@ -27,7 +27,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [type/KeyValue.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/KeyValue.ts#L58)* +*Defined in [type/KeyValue.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/KeyValue.ts#L58)* **Parameters:** @@ -65,7 +65,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L75)* +*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L75)* *__description__*: The types definition of the tuple @@ -80,7 +80,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/1c6a89b/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -95,7 +95,7 @@ getisEmpty(): `boolean` *Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L68)* *__description__*: Checks if the value is an empty value @@ -108,7 +108,7 @@ ___ getkey(): [StorageKey](_primitive_storagekey_.storagekey.md) -*Defined in [type/KeyValue.ts:69](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/KeyValue.ts#L69)* +*Defined in [type/KeyValue.ts:69](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/KeyValue.ts#L69)* *__description__*: The [StorageKey](_primitive_storagekey_.storagekey.md) @@ -121,7 +121,7 @@ ___ getvalue(): [Option](_codec_option_.option.md)<[StorageData](_primitive_storagedata_.storagedata.md)> -*Defined in [type/KeyValue.ts:76](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/KeyValue.ts#L76)* +*Defined in [type/KeyValue.ts:76](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/KeyValue.ts#L76)* *__description__*: The [Option](_codec_option_.option.md) [StorageData](_primitive_storagedata_.storagedata.md) @@ -246,7 +246,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Compares the value of the input to see if there is a match @@ -314,7 +314,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L140)* +*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L140)* *__description__*: Filters the array with the callback @@ -734,7 +734,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L149)* +*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L149)* *__description__*: Maps the array with the callback @@ -1042,7 +1042,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1059,7 +1059,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Returns a hex string representation of the value @@ -1076,7 +1076,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L105)* +*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L105)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1110,7 +1110,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L114)* +*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L114)* *__description__*: Returns the string representation of the value @@ -1127,7 +1127,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L123)* +*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L123)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1184,7 +1184,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/1c6a89b/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_type_lockperiods_.lockperiods.md b/docs/types/classes/_type_lockperiods_.lockperiods.md index 25b74e1e0c..d4fa5d4812 100644 --- a/docs/types/classes/_type_lockperiods_.lockperiods.md +++ b/docs/types/classes/_type_lockperiods_.lockperiods.md @@ -26,7 +26,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [primitive/I8.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/I8.ts#L14)* +*Defined in [primitive/I8.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/I8.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -63,7 +63,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -203,7 +203,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -378,7 +378,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1542,7 +1542,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1583,7 +1583,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1602,7 +1602,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1655,7 +1655,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1701,7 +1701,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1905,7 +1905,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_type_misbehaviorreport_.bftatreport.md b/docs/types/classes/_type_misbehaviorreport_.bftatreport.md index 45607c670b..7b5588a82b 100644 --- a/docs/types/classes/_type_misbehaviorreport_.bftatreport.md +++ b/docs/types/classes/_type_misbehaviorreport_.bftatreport.md @@ -35,7 +35,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L33)* +*Defined in [type/MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L33)* **Parameters:** @@ -82,7 +82,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -95,7 +95,7 @@ ___ geta(): [BftHashSignature](_type_bft_.bfthashsignature.md) -*Defined in [type/MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L45)* +*Defined in [type/MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L45)* *__description__*: The first report [BftHashSignature](_type_bft_.bfthashsignature.md) @@ -108,7 +108,7 @@ ___ getb(): [BftHashSignature](_type_bft_.bfthashsignature.md) -*Defined in [type/MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L52)* +*Defined in [type/MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L52)* *__description__*: The second report [BftHashSignature](_type_bft_.bfthashsignature.md) @@ -123,7 +123,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -138,7 +138,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -151,7 +151,7 @@ ___ getround(): [U32](_primitive_u32_.u32.md) -*Defined in [type/MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L59)* +*Defined in [type/MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L59)* *__description__*: The round this report applies to as [U32](_primitive_u32_.u32.md) @@ -233,7 +233,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -276,7 +276,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -297,7 +297,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -372,7 +372,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -389,7 +389,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -406,7 +406,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -423,7 +423,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -440,7 +440,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -476,7 +476,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_misbehaviorreport_.bftdoublecommit.md b/docs/types/classes/_type_misbehaviorreport_.bftdoublecommit.md index 1d4ef4a8ec..88321452a8 100644 --- a/docs/types/classes/_type_misbehaviorreport_.bftdoublecommit.md +++ b/docs/types/classes/_type_misbehaviorreport_.bftdoublecommit.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L33)* +*Defined in [type/MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L33)* **Parameters:** @@ -78,7 +78,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -93,7 +93,7 @@ geta(): [BftHashSignature](_type_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_type_misbehaviorreport_.bftatreport.md).[a](_type_misbehaviorreport_.bftatreport.md#a)* -*Defined in [type/MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L45)* +*Defined in [type/MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L45)* *__description__*: The first report [BftHashSignature](_type_bft_.bfthashsignature.md) @@ -108,7 +108,7 @@ getb(): [BftHashSignature](_type_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_type_misbehaviorreport_.bftatreport.md).[b](_type_misbehaviorreport_.bftatreport.md#b)* -*Defined in [type/MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L52)* +*Defined in [type/MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L52)* *__description__*: The second report [BftHashSignature](_type_bft_.bfthashsignature.md) @@ -123,7 +123,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -138,7 +138,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -153,7 +153,7 @@ getround(): [U32](_primitive_u32_.u32.md) *Inherited from [BftAtReport](_type_misbehaviorreport_.bftatreport.md).[round](_type_misbehaviorreport_.bftatreport.md#round)* -*Defined in [type/MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L59)* +*Defined in [type/MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L59)* *__description__*: The round this report applies to as [U32](_primitive_u32_.u32.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -278,7 +278,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -299,7 +299,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -374,7 +374,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -391,7 +391,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -408,7 +408,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -425,7 +425,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -442,7 +442,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -478,7 +478,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_misbehaviorreport_.bftdoubleprepare.md b/docs/types/classes/_type_misbehaviorreport_.bftdoubleprepare.md index 2edd97be12..130bb3b77f 100644 --- a/docs/types/classes/_type_misbehaviorreport_.bftdoubleprepare.md +++ b/docs/types/classes/_type_misbehaviorreport_.bftdoubleprepare.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L33)* +*Defined in [type/MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L33)* **Parameters:** @@ -78,7 +78,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -93,7 +93,7 @@ geta(): [BftHashSignature](_type_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_type_misbehaviorreport_.bftatreport.md).[a](_type_misbehaviorreport_.bftatreport.md#a)* -*Defined in [type/MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L45)* +*Defined in [type/MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L45)* *__description__*: The first report [BftHashSignature](_type_bft_.bfthashsignature.md) @@ -108,7 +108,7 @@ getb(): [BftHashSignature](_type_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_type_misbehaviorreport_.bftatreport.md).[b](_type_misbehaviorreport_.bftatreport.md#b)* -*Defined in [type/MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L52)* +*Defined in [type/MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L52)* *__description__*: The second report [BftHashSignature](_type_bft_.bfthashsignature.md) @@ -123,7 +123,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -138,7 +138,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -153,7 +153,7 @@ getround(): [U32](_primitive_u32_.u32.md) *Inherited from [BftAtReport](_type_misbehaviorreport_.bftatreport.md).[round](_type_misbehaviorreport_.bftatreport.md#round)* -*Defined in [type/MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L59)* +*Defined in [type/MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L59)* *__description__*: The round this report applies to as [U32](_primitive_u32_.u32.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -278,7 +278,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -299,7 +299,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -374,7 +374,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -391,7 +391,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -408,7 +408,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -425,7 +425,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -442,7 +442,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -478,7 +478,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_misbehaviorreport_.bftdoublepropose.md b/docs/types/classes/_type_misbehaviorreport_.bftdoublepropose.md index 5ca1ac5555..2e31e340f2 100644 --- a/docs/types/classes/_type_misbehaviorreport_.bftdoublepropose.md +++ b/docs/types/classes/_type_misbehaviorreport_.bftdoublepropose.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L33)* +*Defined in [type/MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L33)* **Parameters:** @@ -78,7 +78,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -93,7 +93,7 @@ geta(): [BftHashSignature](_type_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_type_misbehaviorreport_.bftatreport.md).[a](_type_misbehaviorreport_.bftatreport.md#a)* -*Defined in [type/MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L45)* +*Defined in [type/MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L45)* *__description__*: The first report [BftHashSignature](_type_bft_.bfthashsignature.md) @@ -108,7 +108,7 @@ getb(): [BftHashSignature](_type_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_type_misbehaviorreport_.bftatreport.md).[b](_type_misbehaviorreport_.bftatreport.md#b)* -*Defined in [type/MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L52)* +*Defined in [type/MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L52)* *__description__*: The second report [BftHashSignature](_type_bft_.bfthashsignature.md) @@ -123,7 +123,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -138,7 +138,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -153,7 +153,7 @@ getround(): [U32](_primitive_u32_.u32.md) *Inherited from [BftAtReport](_type_misbehaviorreport_.bftatreport.md).[round](_type_misbehaviorreport_.bftatreport.md#round)* -*Defined in [type/MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L59)* +*Defined in [type/MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L59)* *__description__*: The round this report applies to as [U32](_primitive_u32_.u32.md) @@ -235,7 +235,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -278,7 +278,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -299,7 +299,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -374,7 +374,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -391,7 +391,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -408,7 +408,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -425,7 +425,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -442,7 +442,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -478,7 +478,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.md b/docs/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.md index 01c068f63b..d8b5a73e1a 100644 --- a/docs/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.md +++ b/docs/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/MisbehaviorReport.ts:69](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L69)* +*Defined in [type/MisbehaviorReport.ts:69](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L69)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -89,7 +89,7 @@ ___ geta(): [BftHashSignature](_type_bft_.bfthashsignature.md) -*Defined in [type/MisbehaviorReport.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L80)* +*Defined in [type/MisbehaviorReport.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L80)* *__description__*: The [BftHashSignature](_type_bft_.bfthashsignature.md) the report applies to @@ -104,7 +104,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -119,7 +119,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -132,7 +132,7 @@ ___ getround(): [U32](_primitive_u32_.u32.md) -*Defined in [type/MisbehaviorReport.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L87)* +*Defined in [type/MisbehaviorReport.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L87)* *__description__*: The round as \[\[u32\]\] @@ -214,7 +214,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -257,7 +257,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -278,7 +278,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -353,7 +353,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -370,7 +370,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -387,7 +387,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -404,7 +404,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -421,7 +421,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -457,7 +457,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_misbehaviorreport_.misbehaviorkind.md b/docs/types/classes/_type_misbehaviorreport_.misbehaviorkind.md index cc110a6cf3..2437f6e99f 100644 --- a/docs/types/classes/_type_misbehaviorreport_.misbehaviorkind.md +++ b/docs/types/classes/_type_misbehaviorreport_.misbehaviorkind.md @@ -24,7 +24,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [type/MisbehaviorReport.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L121)* +*Defined in [type/MisbehaviorReport.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L121)* **Parameters:** @@ -45,7 +45,7 @@ ___ getasBftDoubleCommit(): [BftDoubleCommit](_type_misbehaviorreport_.bftdoublecommit.md) -*Defined in [type/MisbehaviorReport.ts:134](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L134)* +*Defined in [type/MisbehaviorReport.ts:134](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L134)* *__description__*: Returns the item as a [BftDoubleCommit](_type_misbehaviorreport_.bftdoublecommit.md) @@ -58,7 +58,7 @@ ___ getasBftDoublePrepare(): [BftDoublePrepare](_type_misbehaviorreport_.bftdoubleprepare.md) -*Defined in [type/MisbehaviorReport.ts:141](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L141)* +*Defined in [type/MisbehaviorReport.ts:141](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L141)* *__description__*: Returns the item as a [BftDoublePrepare](_type_misbehaviorreport_.bftdoubleprepare.md) @@ -71,7 +71,7 @@ ___ getasBftDoublePropose(): [BftDoublePropose](_type_misbehaviorreport_.bftdoublepropose.md) -*Defined in [type/MisbehaviorReport.ts:148](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L148)* +*Defined in [type/MisbehaviorReport.ts:148](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L148)* *__description__*: Returns the item as a [BftDoublePropose](_type_misbehaviorreport_.bftdoublepropose.md) @@ -84,7 +84,7 @@ ___ getasBftProposeOutOfTurn(): [BftProposeOutOfTurn](_type_misbehaviorreport_.bftproposeoutofturn.md) -*Defined in [type/MisbehaviorReport.ts:155](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L155)* +*Defined in [type/MisbehaviorReport.ts:155](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L155)* *__description__*: Returns the item as a [BftProposeOutOfTurn](_type_misbehaviorreport_.bftproposeoutofturn.md) @@ -99,7 +99,7 @@ getencodedLength(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L114)* +*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L114)* *__description__*: The length of the value when encoded as a Uint8Array @@ -114,7 +114,7 @@ getindex(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L121)* +*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L121)* *__description__*: The index of the metadata value @@ -129,7 +129,7 @@ getisEmpty(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isEmpty](_codec_enumtype_.enumtype.md#isempty)* -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L128)* +*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L128)* *__description__*: Checks if the value is an empty value @@ -144,7 +144,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L135)* +*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L135)* *__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type @@ -159,7 +159,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L142)* +*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L142)* *__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type (deprecated, use isNone) @@ -174,7 +174,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L149)* +*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L149)* *__description__*: The name of the type this enum value represents @@ -189,7 +189,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:156](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L156)* +*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L156)* *__description__*: The value of the enum @@ -209,7 +209,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* -*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L163)* +*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L163)* *__description__*: Compares the value of the input to see if there is a match @@ -232,7 +232,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L176)* +*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L176)* *__description__*: Returns a hex string representation of the value @@ -249,7 +249,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L183)* +*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L183)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -264,7 +264,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L192)* +*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L192)* *__description__*: Returns the number representation for the value @@ -281,7 +281,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [codec/EnumType.ts:199](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L199)* +*Defined in [codec/EnumType.ts:199](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L199)* *__description__*: Returns the string representation of the value @@ -298,7 +298,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L209)* +*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -319,7 +319,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/EnumType.ts#L101)* +*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/EnumType.ts#L101)* **Type parameters:** diff --git a/docs/types/classes/_type_misbehaviorreport_.misbehaviorreport.md b/docs/types/classes/_type_misbehaviorreport_.misbehaviorreport.md index 73faa352e4..45ccbaf925 100644 --- a/docs/types/classes/_type_misbehaviorreport_.misbehaviorreport.md +++ b/docs/types/classes/_type_misbehaviorreport_.misbehaviorreport.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/MisbehaviorReport.ts:172](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L172)* +*Defined in [type/MisbehaviorReport.ts:172](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L172)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -91,7 +91,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -106,7 +106,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -119,7 +119,7 @@ ___ getmisbehavior(): [MisbehaviorKind](_type_misbehaviorreport_.misbehaviorkind.md) -*Defined in [type/MisbehaviorReport.ts:185](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L185)* +*Defined in [type/MisbehaviorReport.ts:185](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L185)* *__description__*: The [MisbehaviorKind](_type_misbehaviorreport_.misbehaviorkind.md) @@ -132,7 +132,7 @@ ___ getparentHash(): [Hash](_type_hash_.hash.md) -*Defined in [type/MisbehaviorReport.ts:192](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L192)* +*Defined in [type/MisbehaviorReport.ts:192](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L192)* *__description__*: The [Hash](_type_hash_.hash.md) of the parent block @@ -145,7 +145,7 @@ ___ getparentNumber(): [BlockNumber](_type_blocknumber_.blocknumber.md) -*Defined in [type/MisbehaviorReport.ts:199](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L199)* +*Defined in [type/MisbehaviorReport.ts:199](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L199)* *__description__*: The [BlockNumber](_type_blocknumber_.blocknumber.md) of the parent @@ -158,7 +158,7 @@ ___ gettarget(): [AuthorityId](_type_authorityid_.authorityid.md) -*Defined in [type/MisbehaviorReport.ts:206](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/MisbehaviorReport.ts#L206)* +*Defined in [type/MisbehaviorReport.ts:206](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/MisbehaviorReport.ts#L206)* *__description__*: The [authorityId](_type_bft_.bftauthoritysignature.md#authorityid) the report applies to @@ -240,7 +240,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -283,7 +283,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -304,7 +304,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -379,7 +379,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -396,7 +396,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -413,7 +413,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -430,7 +430,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -447,7 +447,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -483,7 +483,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_newaccountoutcome_.newaccountoutcome.md b/docs/types/classes/_type_newaccountoutcome_.newaccountoutcome.md index e1b2421693..dc1d366622 100644 --- a/docs/types/classes/_type_newaccountoutcome_.newaccountoutcome.md +++ b/docs/types/classes/_type_newaccountoutcome_.newaccountoutcome.md @@ -24,7 +24,7 @@ *Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* -*Defined in [type/NewAccountOutcome.ts:13](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/NewAccountOutcome.ts#L13)* +*Defined in [type/NewAccountOutcome.ts:13](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/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/1c6a89b/packages/types/src/codec/Enum.ts#L64)* +*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -61,7 +61,7 @@ getisEmpty(): `boolean` *Inherited from [Enum](_codec_enum_.enum.md).[isEmpty](_codec_enum_.enum.md#isempty)* -*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L71)* +*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L71)* *__description__*: Checks if the value is an empty value (always false) @@ -81,7 +81,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[eq](_codec_enum_.enum.md#eq)* -*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L78)* +*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L78)* *__description__*: Compares the value of the input to see if there is a match @@ -104,7 +104,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toHex](_codec_enum_.enum.md#tohex)* -*Defined in [codec/Enum.ts:91](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L91)* +*Defined in [codec/Enum.ts:91](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L91)* *__description__*: Returns a hex string representation of the value @@ -121,7 +121,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toJSON](_codec_enum_.enum.md#tojson)* -*Defined in [codec/Enum.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L98)* +*Defined in [codec/Enum.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L98)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -136,7 +136,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* -*Defined in [codec/Enum.ts:105](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L105)* +*Defined in [codec/Enum.ts:105](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L105)* *__description__*: Returns the number representation for the value @@ -153,7 +153,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toString](_codec_enum_.enum.md#tostring)* -*Defined in [codec/Enum.ts:112](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L112)* +*Defined in [codec/Enum.ts:112](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L112)* *__description__*: Returns the string representation of the value @@ -170,7 +170,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toU8a](_codec_enum_.enum.md#tou8a)* -*Defined in [codec/Enum.ts:120](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L120)* +*Defined in [codec/Enum.ts:120](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L120)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -191,7 +191,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/1c6a89b/packages/types/src/codec/Enum.ts#L47)* +*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L47)* **Parameters:** diff --git a/docs/types/classes/_type_nonce_.nonce.md b/docs/types/classes/_type_nonce_.nonce.md index c1f76e00f1..c97dd6da0c 100644 --- a/docs/types/classes/_type_nonce_.nonce.md +++ b/docs/types/classes/_type_nonce_.nonce.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [primitive/U64.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/U64.ts#L14)* +*Defined in [primitive/U64.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/U64.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -63,7 +63,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -203,7 +203,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -378,7 +378,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1542,7 +1542,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1583,7 +1583,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1602,7 +1602,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1655,7 +1655,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1701,7 +1701,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1905,7 +1905,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_type_noncecompact_.noncecompact.md b/docs/types/classes/_type_noncecompact_.noncecompact.md index 115d673a9b..cd7cc9de60 100644 --- a/docs/types/classes/_type_noncecompact_.noncecompact.md +++ b/docs/types/classes/_type_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/1c6a89b/packages/types/src/codec/Compact.ts#L23)* +*Defined in [codec/Compact.ts:23](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/types/src/codec/Compact.ts#L41)* +*Defined in [codec/Compact.ts:41](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L41)* Prepend a Uint8Array with its compact length. @@ -64,7 +64,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/1c6a89b/packages/types/src/codec/Compact.ts#L42)* +*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L42)* ___ @@ -75,7 +75,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/1c6a89b/packages/types/src/codec/Compact.ts#L43)* +*Defined in [codec/Compact.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L43)* ___ @@ -89,7 +89,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/1c6a89b/packages/types/src/codec/Compact.ts#L72)* +*Defined in [codec/Compact.ts:72](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L72)* *__description__*: The length of the value when encoded as a Uint8Array @@ -104,7 +104,7 @@ getisEmpty(): `boolean` *Inherited from [Compact](_codec_compact_.compact.md).[isEmpty](_codec_compact_.compact.md#isempty)* -*Defined in [codec/Compact.ts:79](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L79)* +*Defined in [codec/Compact.ts:79](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L79)* *__description__*: Checks if the value is an empty value @@ -122,7 +122,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[bitLength](_codec_compact_.compact.md#bitlength)* -*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L86)* +*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L86)* *__description__*: Returns the number of bits in the value @@ -139,7 +139,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[eq](_codec_compact_.compact.md#eq)* -*Defined in [codec/Compact.ts:93](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L93)* +*Defined in [codec/Compact.ts:93](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L93)* *__description__*: Compares the value of the input to see if there is a match @@ -160,7 +160,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[toBn](_codec_compact_.compact.md#tobn)* -*Defined in [codec/Compact.ts:104](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L104)* +*Defined in [codec/Compact.ts:104](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L104)* *__description__*: Returns the BN representation of the number @@ -177,7 +177,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[toHex](_codec_compact_.compact.md#tohex)* -*Defined in [codec/Compact.ts:111](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L111)* +*Defined in [codec/Compact.ts:111](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L111)* *__description__*: Returns a hex string representation of the value @@ -194,7 +194,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[toJSON](_codec_compact_.compact.md#tojson)* -*Defined in [codec/Compact.ts:118](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L118)* +*Defined in [codec/Compact.ts:118](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L118)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -209,7 +209,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[toNumber](_codec_compact_.compact.md#tonumber)* -*Defined in [codec/Compact.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L125)* +*Defined in [codec/Compact.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L125)* *__description__*: Returns the number representation for the value @@ -226,7 +226,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[toString](_codec_compact_.compact.md#tostring)* -*Defined in [codec/Compact.ts:132](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L132)* +*Defined in [codec/Compact.ts:132](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L132)* *__description__*: Returns the string representation of the value @@ -243,7 +243,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[toU8a](_codec_compact_.compact.md#tou8a)* -*Defined in [codec/Compact.ts:140](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L140)* +*Defined in [codec/Compact.ts:140](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L140)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -264,7 +264,7 @@ ___ *Inherited from [Compact](_codec_compact_.compact.md).[unwrap](_codec_compact_.compact.md#unwrap)* -*Defined in [codec/Compact.ts:147](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Compact.ts#L147)* +*Defined in [codec/Compact.ts:147](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L147)* *__description__*: Returns the embedded [UInt](_codec_uint_.uint.md) or [Moment](_primitive_moment_.moment.md) value @@ -279,7 +279,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/1c6a89b/packages/types/src/codec/Compact.ts#L51)* +*Defined in [codec/Compact.ts:51](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L51)* **Parameters:** @@ -299,7 +299,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/1c6a89b/packages/types/src/codec/Compact.ts#L45)* +*Defined in [codec/Compact.ts:45](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L45)* **Parameters:** @@ -319,7 +319,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/1c6a89b/packages/types/src/codec/Compact.ts#L28)* +*Defined in [codec/Compact.ts:28](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Compact.ts#L28)* **Parameters:** diff --git a/docs/types/classes/_type_origin_.origin.md b/docs/types/classes/_type_origin_.origin.md index 2831225e0d..d06e4afe17 100644 --- a/docs/types/classes/_type_origin_.origin.md +++ b/docs/types/classes/_type_origin_.origin.md @@ -22,7 +22,7 @@ ⊕ **new Origin**(): [Origin](_type_origin_.origin.md) -*Defined in [type/Origin.ts:13](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Origin.ts#L13)* +*Defined in [type/Origin.ts:13](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Origin.ts#L13)* **Returns:** [Origin](_type_origin_.origin.md) @@ -38,7 +38,7 @@ getencodedLength(): `number` *Inherited from [Null](_primitive_null_.null.md).[encodedLength](_primitive_null_.null.md#encodedlength)* -*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L17)* +*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L17)* *__description__*: The length of the value when encoded as a Uint8Array @@ -53,7 +53,7 @@ getisEmpty(): `boolean` *Inherited from [Null](_primitive_null_.null.md).[isEmpty](_primitive_null_.null.md#isempty)* -*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L24)* +*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L24)* *__description__*: Checks if the value is an empty value (always true) @@ -73,7 +73,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[eq](_primitive_null_.null.md#eq)* -*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L31)* +*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L31)* *__description__*: Compares the value of the input to see if there is a match @@ -96,7 +96,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toHex](_primitive_null_.null.md#tohex)* -*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L38)* +*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L38)* *__description__*: Returns a hex string representation of the value @@ -113,7 +113,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toJSON](_primitive_null_.null.md#tojson)* -*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L45)* +*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L45)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -130,7 +130,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toString](_primitive_null_.null.md#tostring)* -*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L52)* +*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L52)* *__description__*: Returns the string representation of the value @@ -147,7 +147,7 @@ ___ *Inherited from [Null](_primitive_null_.null.md).[toU8a](_primitive_null_.null.md#tou8a)* -*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Null.ts#L60)* +*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Null.ts#L60)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_paraid_.paraid.md b/docs/types/classes/_type_paraid_.paraid.md index ab233a0809..bf551da822 100644 --- a/docs/types/classes/_type_paraid_.paraid.md +++ b/docs/types/classes/_type_paraid_.paraid.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/U32.ts#L14)* +*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/U32.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -63,7 +63,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -203,7 +203,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -378,7 +378,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1542,7 +1542,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1583,7 +1583,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1602,7 +1602,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1655,7 +1655,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1701,7 +1701,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1905,7 +1905,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_type_peerinfo_.peerinfo.md b/docs/types/classes/_type_peerinfo_.peerinfo.md index 49cffc5a2e..6fd1516e7c 100644 --- a/docs/types/classes/_type_peerinfo_.peerinfo.md +++ b/docs/types/classes/_type_peerinfo_.peerinfo.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/PeerInfo.ts:24](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/PeerInfo.ts#L24)* +*Defined in [type/PeerInfo.ts:24](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/PeerInfo.ts#L24)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -89,7 +89,7 @@ ___ getbestHash(): [Hash](_type_hash_.hash.md) -*Defined in [type/PeerInfo.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/PeerInfo.ts#L39)* +*Defined in [type/PeerInfo.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/PeerInfo.ts#L39)* *__description__*: The best block hash for the peer @@ -102,7 +102,7 @@ ___ getbestNumber(): [BlockNumber](_type_blocknumber_.blocknumber.md) -*Defined in [type/PeerInfo.ts:46](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/PeerInfo.ts#L46)* +*Defined in [type/PeerInfo.ts:46](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/PeerInfo.ts#L46)* *__description__*: The best block hash for the peer @@ -117,7 +117,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -130,7 +130,7 @@ ___ getindex(): [USize](_primitive_usize_.usize.md) -*Defined in [type/PeerInfo.ts:53](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/PeerInfo.ts#L53)* +*Defined in [type/PeerInfo.ts:53](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/PeerInfo.ts#L53)* *__description__*: The index of the peer in our list @@ -145,7 +145,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -158,7 +158,7 @@ ___ getpeerId(): [Text](_primitive_text_.text.md) -*Defined in [type/PeerInfo.ts:60](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/PeerInfo.ts#L60)* +*Defined in [type/PeerInfo.ts:60](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/PeerInfo.ts#L60)* *__description__*: The p2p network id for the peer @@ -171,7 +171,7 @@ ___ getprotocolVersion(): [U32](_primitive_u32_.u32.md) -*Defined in [type/PeerInfo.ts:67](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/PeerInfo.ts#L67)* +*Defined in [type/PeerInfo.ts:67](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/PeerInfo.ts#L67)* *__description__*: The index of the peer in our list @@ -184,7 +184,7 @@ ___ getroles(): [Text](_primitive_text_.text.md) -*Defined in [type/PeerInfo.ts:74](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/PeerInfo.ts#L74)* +*Defined in [type/PeerInfo.ts:74](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/PeerInfo.ts#L74)* *__description__*: The roles of the peer on the network @@ -266,7 +266,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -309,7 +309,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -330,7 +330,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -405,7 +405,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -422,7 +422,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -439,7 +439,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -456,7 +456,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -473,7 +473,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -509,7 +509,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_pendingextrinsics_.pendingextrinsics.md b/docs/types/classes/_type_pendingextrinsics_.pendingextrinsics.md index 401cc950b4..e2b532a572 100644 --- a/docs/types/classes/_type_pendingextrinsics_.pendingextrinsics.md +++ b/docs/types/classes/_type_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/1c6a89b/packages/types/src/codec/Vector.ts#L22)* +*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/6eb859c/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:66](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L66)* +*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L66)* *__description__*: The type for the items @@ -67,7 +67,7 @@ getencodedLength(): `number` *Inherited from [Vector](_codec_vector_.vector.md).[encodedLength](_codec_vector_.vector.md#encodedlength)* -*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L73)* +*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L73)* *__description__*: The length of the value when encoded as a Uint8Array @@ -82,7 +82,7 @@ getisEmpty(): `boolean` *Inherited from [Vector](_codec_vector_.vector.md).[isEmpty](_codec_vector_.vector.md#isempty)* -*Defined in [codec/Vector.ts:59](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L59)* +*Defined in [codec/Vector.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L59)* *__description__*: Checks if the value is an empty value @@ -99,7 +99,7 @@ getlength(): `number` *Overrides Array.length* -*Defined in [codec/Vector.ts:82](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L82)* +*Defined in [codec/Vector.ts:82](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L82)* *__description__*: The length of the value @@ -224,7 +224,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[eq](_codec_vector_.vector.md#eq)* -*Defined in [codec/Vector.ts:90](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L90)* +*Defined in [codec/Vector.ts:90](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L90)* *__description__*: Compares the value of the input to see if there is a match @@ -292,7 +292,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Vector.ts:173](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L173)* +*Defined in [codec/Vector.ts:173](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L173)* *__description__*: Filters the array with the callback @@ -632,7 +632,7 @@ ___ *Overrides Array.indexOf* -*Defined in [codec/Vector.ts:97](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L97)* +*Defined in [codec/Vector.ts:97](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L97)* *__description__*: Finds the index of the value in the array @@ -713,7 +713,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Vector.ts:182](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L182)* +*Defined in [codec/Vector.ts:182](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L182)* *__description__*: Maps the array with the callback @@ -1021,7 +1021,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)* -*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L115)* +*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L115)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1038,7 +1038,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)* -*Defined in [codec/Vector.ts:122](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L122)* +*Defined in [codec/Vector.ts:122](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L122)* *__description__*: Returns a hex string representation of the value @@ -1055,7 +1055,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* -*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L129)* +*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L129)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1089,7 +1089,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Vector.ts:138](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L138)* +*Defined in [codec/Vector.ts:138](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L138)* *__description__*: Returns the string representation of the value @@ -1106,7 +1106,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* -*Defined in [codec/Vector.ts:151](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L151)* +*Defined in [codec/Vector.ts:151](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L151)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1163,7 +1163,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/1c6a89b/packages/types/src/codec/Vector.ts#L32)* +*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L32)* **Type parameters:** @@ -1186,7 +1186,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* -*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Vector.ts#L48)* +*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Vector.ts#L48)* **Type parameters:** diff --git a/docs/types/classes/_type_perbill_.perbill.md b/docs/types/classes/_type_perbill_.perbill.md index d6f1c883f1..d5f9964a48 100644 --- a/docs/types/classes/_type_perbill_.perbill.md +++ b/docs/types/classes/_type_perbill_.perbill.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/U32.ts#L14)* +*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/U32.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -63,7 +63,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -203,7 +203,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -378,7 +378,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1542,7 +1542,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1583,7 +1583,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1602,7 +1602,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1655,7 +1655,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1701,7 +1701,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1905,7 +1905,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_type_permill_.permill.md b/docs/types/classes/_type_permill_.permill.md index d25aeaeaed..4f3ffee56c 100644 --- a/docs/types/classes/_type_permill_.permill.md +++ b/docs/types/classes/_type_permill_.permill.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/U32.ts#L14)* +*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/U32.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -63,7 +63,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -203,7 +203,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -378,7 +378,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1542,7 +1542,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1583,7 +1583,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1602,7 +1602,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1655,7 +1655,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1701,7 +1701,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1905,7 +1905,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_type_prefabwasmmodule_.prefabwasmmodule.md b/docs/types/classes/_type_prefabwasmmodule_.prefabwasmmodule.md index 91d928b62d..3be4358998 100644 --- a/docs/types/classes/_type_prefabwasmmodule_.prefabwasmmodule.md +++ b/docs/types/classes/_type_prefabwasmmodule_.prefabwasmmodule.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/PrefabWasmModule.ts:19](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/PrefabWasmModule.ts#L19)* +*Defined in [type/PrefabWasmModule.ts:19](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/PrefabWasmModule.ts#L19)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -89,7 +89,7 @@ ___ getcode(): [Bytes](_primitive_bytes_.bytes.md) -*Defined in [type/PrefabWasmModule.ts:33](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/PrefabWasmModule.ts#L33)* +*Defined in [type/PrefabWasmModule.ts:33](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/PrefabWasmModule.ts#L33)* *__description__*: The code as [Bytes](_primitive_bytes_.bytes.md) @@ -104,7 +104,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -117,7 +117,7 @@ ___ getinitial(): [Compact](_codec_compact_.compact.md) -*Defined in [type/PrefabWasmModule.ts:40](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/PrefabWasmModule.ts#L40)* +*Defined in [type/PrefabWasmModule.ts:40](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/PrefabWasmModule.ts#L40)* *__description__*: The initial as [Compact](_codec_compact_.compact.md) @@ -132,7 +132,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -145,7 +145,7 @@ ___ getmaximum(): [Compact](_codec_compact_.compact.md) -*Defined in [type/PrefabWasmModule.ts:47](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/PrefabWasmModule.ts#L47)* +*Defined in [type/PrefabWasmModule.ts:47](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/PrefabWasmModule.ts#L47)* *__description__*: The maximum as [Compact](_codec_compact_.compact.md) @@ -158,7 +158,7 @@ ___ getscheduleVersion(): [Compact](_codec_compact_.compact.md) -*Defined in [type/PrefabWasmModule.ts:54](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/PrefabWasmModule.ts#L54)* +*Defined in [type/PrefabWasmModule.ts:54](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/PrefabWasmModule.ts#L54)* *__description__*: The scheduleVersion value as [Compact](_codec_compact_.compact.md) @@ -240,7 +240,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -283,7 +283,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -304,7 +304,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -379,7 +379,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -396,7 +396,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -413,7 +413,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -430,7 +430,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -447,7 +447,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -483,7 +483,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_propindex_.propindex.md b/docs/types/classes/_type_propindex_.propindex.md index f355d25ed5..f107e08fbd 100644 --- a/docs/types/classes/_type_propindex_.propindex.md +++ b/docs/types/classes/_type_propindex_.propindex.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/U32.ts#L14)* +*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/U32.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -63,7 +63,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -203,7 +203,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -378,7 +378,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1542,7 +1542,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1583,7 +1583,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1602,7 +1602,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1655,7 +1655,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1701,7 +1701,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1905,7 +1905,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_type_proposal_.proposal.md b/docs/types/classes/_type_proposal_.proposal.md index 7c653935f5..5cce6a32cb 100644 --- a/docs/types/classes/_type_proposal_.proposal.md +++ b/docs/types/classes/_type_proposal_.proposal.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [primitive/Method.ts:70](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L70)* +*Defined in [primitive/Method.ts:70](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L70)* **Parameters:** @@ -79,7 +79,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -94,7 +94,7 @@ getargs(): `Array`<[Codec](../interfaces/_types_.codec.md)> *Inherited from [Method](_primitive_method_.method.md).[args](_primitive_method_.method.md#args)* -*Defined in [primitive/Method.ts:192](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L192)* +*Defined in [primitive/Method.ts:192](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L192)* *__description__*: The arguments for the function call @@ -109,7 +109,7 @@ getargsDef(): `ArgsDef` *Inherited from [Method](_primitive_method_.method.md).[argsDef](_primitive_method_.method.md#argsdef)* -*Defined in [primitive/Method.ts:200](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L200)* +*Defined in [primitive/Method.ts:200](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L200)* *__description__*: Thge argument defintions @@ -124,7 +124,7 @@ getcallIndex(): `Uint8Array` *Inherited from [Method](_primitive_method_.method.md).[callIndex](_primitive_method_.method.md#callindex)* -*Defined in [primitive/Method.ts:207](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L207)* +*Defined in [primitive/Method.ts:207](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L207)* *__description__*: The encoded `[sectionIndex, methodIndex]` identifier @@ -139,7 +139,7 @@ getdata(): `Uint8Array` *Inherited from [Method](_primitive_method_.method.md).[data](_primitive_method_.method.md#data)* -*Defined in [primitive/Method.ts:214](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L214)* +*Defined in [primitive/Method.ts:214](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L214)* *__description__*: The encoded data @@ -154,7 +154,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -169,7 +169,7 @@ gethasOrigin(): `boolean` *Inherited from [Method](_primitive_method_.method.md).[hasOrigin](_primitive_method_.method.md#hasorigin)* -*Defined in [primitive/Method.ts:221](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L221)* +*Defined in [primitive/Method.ts:221](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L221)* *__description__*: `true` if the `Origin` type is on the method (extrinsic method) @@ -184,7 +184,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -199,7 +199,7 @@ getmeta(): [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) *Inherited from [Method](_primitive_method_.method.md).[meta](_primitive_method_.method.md#meta)* -*Defined in [primitive/Method.ts:230](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L230)* +*Defined in [primitive/Method.ts:230](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L230)* *__description__*: The [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) @@ -281,7 +281,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -324,7 +324,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -345,7 +345,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -420,7 +420,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -437,7 +437,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -454,7 +454,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -471,7 +471,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -488,7 +488,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -524,7 +524,7 @@ ___ *Inherited from [Method](_primitive_method_.method.md).[filterOrigin](_primitive_method_.method.md#filterorigin)* -*Defined in [primitive/Method.ts:140](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L140)* +*Defined in [primitive/Method.ts:140](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L140)* **Parameters:** @@ -543,7 +543,7 @@ ___ *Inherited from [Method](_primitive_method_.method.md).[findFunction](_primitive_method_.method.md#findfunction)* -*Defined in [primitive/Method.ts:156](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L156)* +*Defined in [primitive/Method.ts:156](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L156)* **Parameters:** @@ -562,7 +562,7 @@ ___ *Inherited from [Method](_primitive_method_.method.md).[injectMethods](_primitive_method_.method.md#injectmethods)* -*Defined in [primitive/Method.ts:181](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L181)* +*Defined in [primitive/Method.ts:181](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L181)* **Parameters:** @@ -581,7 +581,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_proposalindex_.proposalindex.md b/docs/types/classes/_type_proposalindex_.proposalindex.md index 8ba9172eb7..58adaec435 100644 --- a/docs/types/classes/_type_proposalindex_.proposalindex.md +++ b/docs/types/classes/_type_proposalindex_.proposalindex.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/U32.ts#L14)* +*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/U32.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -63,7 +63,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -203,7 +203,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -378,7 +378,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1542,7 +1542,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1583,7 +1583,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1602,7 +1602,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1655,7 +1655,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1701,7 +1701,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1905,7 +1905,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_type_referendumindex_.referendumindex.md b/docs/types/classes/_type_referendumindex_.referendumindex.md index 138e61d5d4..c32299ea52 100644 --- a/docs/types/classes/_type_referendumindex_.referendumindex.md +++ b/docs/types/classes/_type_referendumindex_.referendumindex.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/U32.ts#L14)* +*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/U32.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -63,7 +63,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -203,7 +203,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -378,7 +378,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1542,7 +1542,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1583,7 +1583,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1602,7 +1602,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1655,7 +1655,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1701,7 +1701,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1905,7 +1905,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_type_referenduminfo_.referenduminfo.md b/docs/types/classes/_type_referenduminfo_.referenduminfo.md index 0077bdec55..f0e2ee768c 100644 --- a/docs/types/classes/_type_referenduminfo_.referenduminfo.md +++ b/docs/types/classes/_type_referenduminfo_.referenduminfo.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/ReferendumInfo.ts:24](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ReferendumInfo.ts#L24)* +*Defined in [type/ReferendumInfo.ts:24](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ReferendumInfo.ts#L24)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -89,7 +89,7 @@ ___ getdelay(): [BlockNumber](_type_blocknumber_.blocknumber.md) -*Defined in [type/ReferendumInfo.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ReferendumInfo.ts#L58)* +*Defined in [type/ReferendumInfo.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ReferendumInfo.ts#L58)* *__description__*: The delay (in blocks) to wait after a successful referendum before deploying @@ -104,7 +104,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -117,7 +117,7 @@ ___ getend(): [BlockNumber](_type_blocknumber_.blocknumber.md) -*Defined in [type/ReferendumInfo.ts:37](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ReferendumInfo.ts#L37)* +*Defined in [type/ReferendumInfo.ts:37](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ReferendumInfo.ts#L37)* *__description__*: When voting on this referendum will end @@ -132,7 +132,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -145,7 +145,7 @@ ___ getproposal(): [Proposal](_type_proposal_.proposal.md) -*Defined in [type/ReferendumInfo.ts:44](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ReferendumInfo.ts#L44)* +*Defined in [type/ReferendumInfo.ts:44](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ReferendumInfo.ts#L44)* *__description__*: The proposal being voted on @@ -158,7 +158,7 @@ ___ getthreshold(): [VoteThreshold](_type_votethreshold_.votethreshold.md) -*Defined in [type/ReferendumInfo.ts:51](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ReferendumInfo.ts#L51)* +*Defined in [type/ReferendumInfo.ts:51](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ReferendumInfo.ts#L51)* *__description__*: The thresholding mechanism to determine whether it passed @@ -240,7 +240,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -283,7 +283,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -304,7 +304,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -379,7 +379,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -396,7 +396,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -413,7 +413,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -430,7 +430,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -447,7 +447,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -483,7 +483,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_runtimeversion_.apiid.md b/docs/types/classes/_type_runtimeversion_.apiid.md index 4cbc58eb24..ddae077ba5 100644 --- a/docs/types/classes/_type_runtimeversion_.apiid.md +++ b/docs/types/classes/_type_runtimeversion_.apiid.md @@ -27,7 +27,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [type/RuntimeVersion.ts:19](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/RuntimeVersion.ts#L19)* +*Defined in [type/RuntimeVersion.ts:19](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/RuntimeVersion.ts#L19)* **Parameters:** @@ -115,7 +115,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -130,7 +130,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -147,7 +147,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -178,7 +178,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -233,7 +233,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -727,7 +727,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -751,7 +751,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -768,7 +768,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -802,7 +802,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -819,7 +819,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_runtimeversion_.runtimeversion.md b/docs/types/classes/_type_runtimeversion_.runtimeversion.md index c023625b25..865cd705a9 100644 --- a/docs/types/classes/_type_runtimeversion_.runtimeversion.md +++ b/docs/types/classes/_type_runtimeversion_.runtimeversion.md @@ -30,7 +30,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/RuntimeVersion.ts:72](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/RuntimeVersion.ts#L72)* +*Defined in [type/RuntimeVersion.ts:72](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/RuntimeVersion.ts#L72)* **Parameters:** @@ -77,7 +77,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -90,7 +90,7 @@ ___ getapis(): [Vector](_codec_vector_.vector.md)<[RuntimeVersionApi](_type_runtimeversion_.runtimeversionapi.md)> -*Defined in [type/RuntimeVersion.ts:93](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/RuntimeVersion.ts#L93)* +*Defined in [type/RuntimeVersion.ts:93](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/RuntimeVersion.ts#L93)* *__description__*: The available APIs as [RuntimeVersionApi](_type_runtimeversion_.runtimeversionapi.md) @@ -103,7 +103,7 @@ ___ getauthoringVersion(): [U32](_primitive_u32_.u32.md) -*Defined in [type/RuntimeVersion.ts:100](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/RuntimeVersion.ts#L100)* +*Defined in [type/RuntimeVersion.ts:100](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/RuntimeVersion.ts#L100)* *__description__*: The authoring version as [U32](_primitive_u32_.u32.md) @@ -118,7 +118,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -131,7 +131,7 @@ ___ getimplName(): [Text](_primitive_text_.text.md) -*Defined in [type/RuntimeVersion.ts:107](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/RuntimeVersion.ts#L107)* +*Defined in [type/RuntimeVersion.ts:107](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/RuntimeVersion.ts#L107)* *__description__*: The implementation name @@ -144,7 +144,7 @@ ___ getimplVersion(): [U32](_primitive_u32_.u32.md) -*Defined in [type/RuntimeVersion.ts:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/RuntimeVersion.ts#L114)* +*Defined in [type/RuntimeVersion.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/RuntimeVersion.ts#L114)* *__description__*: The implementation version @@ -159,7 +159,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -172,7 +172,7 @@ ___ getspecName(): [Text](_primitive_text_.text.md) -*Defined in [type/RuntimeVersion.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/RuntimeVersion.ts#L121)* +*Defined in [type/RuntimeVersion.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/RuntimeVersion.ts#L121)* *__description__*: The specification name @@ -185,7 +185,7 @@ ___ getspecVersion(): [U32](_primitive_u32_.u32.md) -*Defined in [type/RuntimeVersion.ts:128](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/RuntimeVersion.ts#L128)* +*Defined in [type/RuntimeVersion.ts:128](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/RuntimeVersion.ts#L128)* *__description__*: The specification version @@ -267,7 +267,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -310,7 +310,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -331,7 +331,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -406,7 +406,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -423,7 +423,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -440,7 +440,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -457,7 +457,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -474,7 +474,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -510,7 +510,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_runtimeversion_.runtimeversionapi.md b/docs/types/classes/_type_runtimeversion_.runtimeversionapi.md index b7b52f0c38..2af19129a0 100644 --- a/docs/types/classes/_type_runtimeversion_.runtimeversionapi.md +++ b/docs/types/classes/_type_runtimeversion_.runtimeversionapi.md @@ -27,7 +27,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [type/RuntimeVersion.ts:35](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/RuntimeVersion.ts#L35)* +*Defined in [type/RuntimeVersion.ts:35](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/RuntimeVersion.ts#L35)* **Parameters:** @@ -65,7 +65,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L75)* +*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L75)* *__description__*: The types definition of the tuple @@ -80,7 +80,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/1c6a89b/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -93,7 +93,7 @@ ___ getid(): [ApiId](_type_runtimeversion_.apiid.md) -*Defined in [type/RuntimeVersion.ts:46](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/RuntimeVersion.ts#L46)* +*Defined in [type/RuntimeVersion.ts:46](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/RuntimeVersion.ts#L46)* *__description__*: The [ApiId](_type_runtimeversion_.apiid.md) @@ -108,7 +108,7 @@ getisEmpty(): `boolean` *Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L68)* *__description__*: Checks if the value is an empty value @@ -121,7 +121,7 @@ ___ getversion(): [U32](_primitive_u32_.u32.md) -*Defined in [type/RuntimeVersion.ts:53](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/RuntimeVersion.ts#L53)* +*Defined in [type/RuntimeVersion.ts:53](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/RuntimeVersion.ts#L53)* *__description__*: The specific version as [U32](_primitive_u32_.u32.md) @@ -246,7 +246,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Compares the value of the input to see if there is a match @@ -314,7 +314,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L140)* +*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L140)* *__description__*: Filters the array with the callback @@ -734,7 +734,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L149)* +*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L149)* *__description__*: Maps the array with the callback @@ -1042,7 +1042,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1059,7 +1059,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Returns a hex string representation of the value @@ -1076,7 +1076,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L105)* +*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L105)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1110,7 +1110,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L114)* +*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L114)* *__description__*: Returns the string representation of the value @@ -1127,7 +1127,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L123)* +*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L123)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1184,7 +1184,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/1c6a89b/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_type_schedule_.schedule.md b/docs/types/classes/_type_schedule_.schedule.md index 6d78df2666..dfbc76c6eb 100644 --- a/docs/types/classes/_type_schedule_.schedule.md +++ b/docs/types/classes/_type_schedule_.schedule.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/Schedule.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Schedule.ts#L14)* +*Defined in [type/Schedule.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Schedule.ts#L14)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -91,7 +91,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -104,7 +104,7 @@ ___ getgrowMemCost(): [Gas](_type_gas_.gas.md) -*Defined in [type/Schedule.ts:32](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Schedule.ts#L32)* +*Defined in [type/Schedule.ts:32](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Schedule.ts#L32)* *__description__*: Gas cost of a growing memory by single page. @@ -119,7 +119,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -132,7 +132,7 @@ ___ getmaxMemoryPages(): [U32](_primitive_u32_.u32.md) -*Defined in [type/Schedule.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Schedule.ts#L39)* +*Defined in [type/Schedule.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Schedule.ts#L39)* *__description__*: What is the maximal memory pages amount is allowed to have for a contract. @@ -145,7 +145,7 @@ ___ getmaxStackHeight(): [U32](_primitive_u32_.u32.md) -*Defined in [type/Schedule.ts:46](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Schedule.ts#L46)* +*Defined in [type/Schedule.ts:46](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Schedule.ts#L46)* *__description__*: How tall the stack is allowed to grow? @@ -158,7 +158,7 @@ ___ getputCodePerByteCost(): [Gas](_type_gas_.gas.md) -*Defined in [type/Schedule.ts:53](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Schedule.ts#L53)* +*Defined in [type/Schedule.ts:53](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Schedule.ts#L53)* *__description__*: Cost of putting a byte of code into the storage. @@ -171,7 +171,7 @@ ___ getregularOpCost(): [Gas](_type_gas_.gas.md) -*Defined in [type/Schedule.ts:60](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Schedule.ts#L60)* +*Defined in [type/Schedule.ts:60](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Schedule.ts#L60)* *__description__*: Gas cost of a regular operation. @@ -184,7 +184,7 @@ ___ getreturnDataPerByteCost(): [Gas](_type_gas_.gas.md) -*Defined in [type/Schedule.ts:67](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Schedule.ts#L67)* +*Defined in [type/Schedule.ts:67](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Schedule.ts#L67)* *__description__*: Gas cost per one byte returned. @@ -197,7 +197,7 @@ ___ getsandboxDataReadCost(): [Gas](_type_gas_.gas.md) -*Defined in [type/Schedule.ts:74](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Schedule.ts#L74)* +*Defined in [type/Schedule.ts:74](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Schedule.ts#L74)* *__description__*: Gas cost per one byte read from the sandbox memory. @@ -210,7 +210,7 @@ ___ getsandboxDataWriteCost(): [Gas](_type_gas_.gas.md) -*Defined in [type/Schedule.ts:81](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Schedule.ts#L81)* +*Defined in [type/Schedule.ts:81](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Schedule.ts#L81)* *__description__*: Gas cost per one byte written to the sandbox memory. @@ -223,7 +223,7 @@ ___ getversion(): [U32](_primitive_u32_.u32.md) -*Defined in [type/Schedule.ts:88](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Schedule.ts#L88)* +*Defined in [type/Schedule.ts:88](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Schedule.ts#L88)* *__description__*: Version of the schedule. @@ -305,7 +305,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -348,7 +348,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -369,7 +369,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -444,7 +444,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -461,7 +461,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -478,7 +478,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -495,7 +495,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -512,7 +512,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -548,7 +548,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_seedof_.seedof.md b/docs/types/classes/_type_seedof_.seedof.md index 6d9479e065..5e59d7d517 100644 --- a/docs/types/classes/_type_seedof_.seedof.md +++ b/docs/types/classes/_type_seedof_.seedof.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [primitive/H256.ts:15](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/H256.ts#L15)* +*Defined in [primitive/H256.ts:15](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/H256.ts#L15)* **Parameters:** @@ -117,7 +117,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -132,7 +132,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -149,7 +149,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -180,7 +180,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -235,7 +235,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -729,7 +729,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -753,7 +753,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -770,7 +770,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -804,7 +804,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -821,7 +821,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_sessionkey_.sessionkey.md b/docs/types/classes/_type_sessionkey_.sessionkey.md index 889f7e9160..9951efe892 100644 --- a/docs/types/classes/_type_sessionkey_.sessionkey.md +++ b/docs/types/classes/_type_sessionkey_.sessionkey.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [type/AccountId.ts:19](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountId.ts#L19)* +*Defined in [type/AccountId.ts:19](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountId.ts#L19)* **Parameters:** @@ -117,7 +117,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -132,7 +132,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -149,7 +149,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -180,7 +180,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -237,7 +237,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [type/AccountId.ts:46](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountId.ts#L46)* +*Defined in [type/AccountId.ts:46](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountId.ts#L46)* *__description__*: Compares the value of the input to see if there is a match @@ -731,7 +731,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -755,7 +755,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -774,7 +774,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [type/AccountId.ts:53](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountId.ts#L53)* +*Defined in [type/AccountId.ts:53](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountId.ts#L53)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -808,7 +808,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Defined in [type/AccountId.ts:60](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountId.ts#L60)* +*Defined in [type/AccountId.ts:60](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountId.ts#L60)* *__description__*: Returns the string representation of the value @@ -825,7 +825,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -861,7 +861,7 @@ ___ *Inherited from [AccountId](_type_accountid_.accountid.md).[encode](_type_accountid_.accountid.md#encode)* -*Defined in [type/AccountId.ts:27](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountId.ts#L27)* +*Defined in [type/AccountId.ts:27](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountId.ts#L27)* **Parameters:** diff --git a/docs/types/classes/_type_signature_.ed25519signature.md b/docs/types/classes/_type_signature_.ed25519signature.md index 500b6a47de..4cc51e16f7 100644 --- a/docs/types/classes/_type_signature_.ed25519signature.md +++ b/docs/types/classes/_type_signature_.ed25519signature.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [primitive/H512.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/H512.ts#L14)* +*Defined in [primitive/H512.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/H512.ts#L14)* **Parameters:** @@ -117,7 +117,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -132,7 +132,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -149,7 +149,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -180,7 +180,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -235,7 +235,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -729,7 +729,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -753,7 +753,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -770,7 +770,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -804,7 +804,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -821,7 +821,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_signature_.signature.md b/docs/types/classes/_type_signature_.signature.md index 3da001c4a1..c77e0d54fb 100644 --- a/docs/types/classes/_type_signature_.signature.md +++ b/docs/types/classes/_type_signature_.signature.md @@ -35,7 +35,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [primitive/H512.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/H512.ts#L14)* +*Defined in [primitive/H512.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/H512.ts#L14)* **Parameters:** @@ -123,7 +123,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/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -138,7 +138,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -155,7 +155,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -186,7 +186,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -241,7 +241,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -735,7 +735,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -759,7 +759,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -776,7 +776,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -810,7 +810,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -827,7 +827,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_signature_.sr25519signature.md b/docs/types/classes/_type_signature_.sr25519signature.md index 58c94c943f..ffb17f5c24 100644 --- a/docs/types/classes/_type_signature_.sr25519signature.md +++ b/docs/types/classes/_type_signature_.sr25519signature.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [primitive/H512.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/H512.ts#L14)* +*Defined in [primitive/H512.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/H512.ts#L14)* **Parameters:** @@ -117,7 +117,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -132,7 +132,7 @@ getisEmpty(): `boolean` *Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L43)* *__description__*: Returns true if the type wraps an empty/default all-0 value @@ -149,7 +149,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L50)* +*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L50)* *__description__*: The length of the value @@ -180,7 +180,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8aFixed.ts#L52)* +*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8aFixed.ts#L52)* *__description__*: Returns the number of bits in the value @@ -235,7 +235,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L58)* +*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L58)* *__description__*: Compares the value of the input to see if there is a match @@ -729,7 +729,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L73)* +*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L73)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -753,7 +753,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L80)* +*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L80)* *__description__*: Returns a hex string representation of the value @@ -770,7 +770,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L87)* +*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L87)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -804,7 +804,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L94)* +*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L94)* *__description__*: Returns the string representation of the value @@ -821,7 +821,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/U8a.ts#L102)* +*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/U8a.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_signaturepayload_.signaturepayload.md b/docs/types/classes/_type_signaturepayload_.signaturepayload.md index 44e92180bc..b65b3672f7 100644 --- a/docs/types/classes/_type_signaturepayload_.signaturepayload.md +++ b/docs/types/classes/_type_signaturepayload_.signaturepayload.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/SignaturePayload.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/SignaturePayload.ts#L36)* +*Defined in [type/SignaturePayload.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/SignaturePayload.ts#L36)* **Parameters:** @@ -78,7 +78,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -91,7 +91,7 @@ ___ getblockHash(): [Hash](_type_hash_.hash.md) -*Defined in [type/SignaturePayload.ts:57](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/SignaturePayload.ts#L57)* +*Defined in [type/SignaturePayload.ts:57](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/SignaturePayload.ts#L57)* *__description__*: The block [Hash](_type_hash_.hash.md) the signature applies to (mortal/immortal) @@ -106,7 +106,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -119,7 +119,7 @@ ___ getera(): [ExtrinsicEra](_type_extrinsicera_.extrinsicera.md) -*Defined in [type/SignaturePayload.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/SignaturePayload.ts#L71)* +*Defined in [type/SignaturePayload.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/SignaturePayload.ts#L71)* *__description__*: The [ExtrinsicEra](_type_extrinsicera_.extrinsicera.md) @@ -134,7 +134,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -147,7 +147,7 @@ ___ getisSigned(): `boolean` -*Defined in [type/SignaturePayload.ts:50](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/SignaturePayload.ts#L50)* +*Defined in [type/SignaturePayload.ts:50](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/SignaturePayload.ts#L50)* *__description__*: `true` if the payload refers to a valid signature @@ -160,7 +160,7 @@ ___ getmethod(): [Method](_primitive_method_.method.md) -*Defined in [type/SignaturePayload.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/SignaturePayload.ts#L64)* +*Defined in [type/SignaturePayload.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/SignaturePayload.ts#L64)* *__description__*: The [Method](_primitive_method_.method.md) contained in the payload @@ -173,7 +173,7 @@ ___ getnonce(): [Nonce](_type_nonce_.nonce.md) -*Defined in [type/SignaturePayload.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/SignaturePayload.ts#L78)* +*Defined in [type/SignaturePayload.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/SignaturePayload.ts#L78)* *__description__*: The [Nonce](_type_nonce_.nonce.md) @@ -186,7 +186,7 @@ ___ getsignature(): `Uint8Array` -*Defined in [type/SignaturePayload.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/SignaturePayload.ts#L85)* +*Defined in [type/SignaturePayload.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/SignaturePayload.ts#L85)* *__description__*: The raw signature as a `Uint8Array` @@ -268,7 +268,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -311,7 +311,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -332,7 +332,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -405,7 +405,7 @@ ___ ▸ **sign**(signerPair: *`KeyringPair`*, version?: *[RuntimeVersion](_type_runtimeversion_.runtimeversion.md)*): `Uint8Array` -*Defined in [type/SignaturePayload.ts:96](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/SignaturePayload.ts#L96)* +*Defined in [type/SignaturePayload.ts:96](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/SignaturePayload.ts#L96)* *__description__*: Sign the payload with the keypair @@ -427,7 +427,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -444,7 +444,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -461,7 +461,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -478,7 +478,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -495,7 +495,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -531,7 +531,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_signedblock_.signedblock.md b/docs/types/classes/_type_signedblock_.signedblock.md index 5a0aac13b1..eef1b1bacd 100644 --- a/docs/types/classes/_type_signedblock_.signedblock.md +++ b/docs/types/classes/_type_signedblock_.signedblock.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/SignedBlock.ts:22](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/SignedBlock.ts#L22)* +*Defined in [type/SignedBlock.ts:22](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/SignedBlock.ts#L22)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -89,7 +89,7 @@ ___ getblock(): [Block](_type_block_.block.md) -*Defined in [type/SignedBlock.ts:33](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/SignedBlock.ts#L33)* +*Defined in [type/SignedBlock.ts:33](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/SignedBlock.ts#L33)* *__description__*: The wrapped [Block](_type_block_.block.md) @@ -104,7 +104,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -117,7 +117,7 @@ ___ gethash(): [Hash](_type_hash_.hash.md) -*Defined in [type/SignedBlock.ts:40](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/SignedBlock.ts#L40)* +*Defined in [type/SignedBlock.ts:40](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/SignedBlock.ts#L40)* *__description__*: Block/header [Hash](_type_hash_.hash.md) @@ -132,7 +132,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -145,7 +145,7 @@ ___ getjustification(): [Justification](_type_justification_.justification.md) -*Defined in [type/SignedBlock.ts:47](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/SignedBlock.ts#L47)* +*Defined in [type/SignedBlock.ts:47](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/SignedBlock.ts#L47)* *__description__*: The wrapped [Justification](_type_justification_.justification.md) @@ -227,7 +227,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -270,7 +270,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -291,7 +291,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -383,7 +383,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -400,7 +400,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -417,7 +417,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -434,7 +434,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -470,7 +470,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_storagechangeset_.storagechangeset.md b/docs/types/classes/_type_storagechangeset_.storagechangeset.md index c1cc9da15b..07562715ab 100644 --- a/docs/types/classes/_type_storagechangeset_.storagechangeset.md +++ b/docs/types/classes/_type_storagechangeset_.storagechangeset.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/StorageChangeSet.ts:24](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/StorageChangeSet.ts#L24)* +*Defined in [type/StorageChangeSet.ts:24](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/StorageChangeSet.ts#L24)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -89,7 +89,7 @@ ___ getblock(): [Hash](_type_hash_.hash.md) -*Defined in [type/StorageChangeSet.ts:42](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/StorageChangeSet.ts#L42)* +*Defined in [type/StorageChangeSet.ts:42](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/StorageChangeSet.ts#L42)* *__description__*: The block [Hash](_type_hash_.hash.md) @@ -102,7 +102,7 @@ ___ getchanges(): [Vector](_codec_vector_.vector.md)<[KeyValueOption](_type_keyvalue_.keyvalueoption.md)> -*Defined in [type/StorageChangeSet.ts:35](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/StorageChangeSet.ts#L35)* +*Defined in [type/StorageChangeSet.ts:35](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/StorageChangeSet.ts#L35)* *__description__*: The applicable changes as [KeyValueOption](_type_keyvalue_.keyvalueoption.md) @@ -117,7 +117,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -132,7 +132,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -214,7 +214,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -257,7 +257,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -278,7 +278,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -353,7 +353,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -370,7 +370,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -387,7 +387,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -404,7 +404,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -421,7 +421,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -457,7 +457,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_storedpendingchange_.nextauthority.md b/docs/types/classes/_type_storedpendingchange_.nextauthority.md index 0ce859bc6b..1e70ddd898 100644 --- a/docs/types/classes/_type_storedpendingchange_.nextauthority.md +++ b/docs/types/classes/_type_storedpendingchange_.nextauthority.md @@ -27,7 +27,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [type/StoredPendingChange.ts:30](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/StoredPendingChange.ts#L30)* +*Defined in [type/StoredPendingChange.ts:30](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/StoredPendingChange.ts#L30)* **Parameters:** @@ -65,7 +65,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L75)* +*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L75)* *__description__*: The types definition of the tuple @@ -80,7 +80,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/1c6a89b/packages/types/src/codec/Tuple.ts#L59)* +*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L59)* *__description__*: The length of the value when encoded as a Uint8Array @@ -93,7 +93,7 @@ ___ getindex(): [U64](_primitive_u64_.u64.md) -*Defined in [type/StoredPendingChange.ts:38](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/StoredPendingChange.ts#L38)* +*Defined in [type/StoredPendingChange.ts:38](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/StoredPendingChange.ts#L38)* **Returns:** [U64](_primitive_u64_.u64.md) @@ -106,7 +106,7 @@ getisEmpty(): `boolean` *Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L68)* +*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L68)* *__description__*: Checks if the value is an empty value @@ -119,7 +119,7 @@ ___ getsessionKey(): [SessionKey](_type_sessionkey_.sessionkey.md) -*Defined in [type/StoredPendingChange.ts:42](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/StoredPendingChange.ts#L42)* +*Defined in [type/StoredPendingChange.ts:42](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/StoredPendingChange.ts#L42)* **Returns:** [SessionKey](_type_sessionkey_.sessionkey.md) @@ -242,7 +242,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L84)* +*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L84)* *__description__*: Compares the value of the input to see if there is a match @@ -310,7 +310,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L140)* +*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L140)* *__description__*: Filters the array with the callback @@ -730,7 +730,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L149)* +*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L149)* *__description__*: Maps the array with the callback @@ -1038,7 +1038,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L91)* +*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L91)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1055,7 +1055,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L98)* +*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L98)* *__description__*: Returns a hex string representation of the value @@ -1072,7 +1072,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L105)* +*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L105)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1106,7 +1106,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L114)* +*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L114)* *__description__*: Returns the string representation of the value @@ -1123,7 +1123,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Tuple.ts#L123)* +*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L123)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1180,7 +1180,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/1c6a89b/packages/types/src/codec/Tuple.ts#L48)* +*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Tuple.ts#L48)* **Parameters:** diff --git a/docs/types/classes/_type_storedpendingchange_.storedpendingchange.md b/docs/types/classes/_type_storedpendingchange_.storedpendingchange.md index ff1ba814dc..1d472b4771 100644 --- a/docs/types/classes/_type_storedpendingchange_.storedpendingchange.md +++ b/docs/types/classes/_type_storedpendingchange_.storedpendingchange.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/StoredPendingChange.ts:52](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/StoredPendingChange.ts#L52)* +*Defined in [type/StoredPendingChange.ts:52](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/StoredPendingChange.ts#L52)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -89,7 +89,7 @@ ___ getdelay(): [BlockNumber](_type_blocknumber_.blocknumber.md) -*Defined in [type/StoredPendingChange.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/StoredPendingChange.ts#L64)* +*Defined in [type/StoredPendingChange.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/StoredPendingChange.ts#L64)* **Returns:** [BlockNumber](_type_blocknumber_.blocknumber.md) @@ -102,7 +102,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -117,7 +117,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -130,7 +130,7 @@ ___ getnextAuthorities(): [Vector](_codec_vector_.vector.md)<[NextAuthority](_type_storedpendingchange_.nextauthority.md)> -*Defined in [type/StoredPendingChange.ts:68](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/StoredPendingChange.ts#L68)* +*Defined in [type/StoredPendingChange.ts:68](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/StoredPendingChange.ts#L68)* **Returns:** [Vector](_codec_vector_.vector.md)<[NextAuthority](_type_storedpendingchange_.nextauthority.md)> @@ -141,7 +141,7 @@ ___ getscheduledAt(): [BlockNumber](_type_blocknumber_.blocknumber.md) -*Defined in [type/StoredPendingChange.ts:72](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/StoredPendingChange.ts#L72)* +*Defined in [type/StoredPendingChange.ts:72](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/StoredPendingChange.ts#L72)* **Returns:** [BlockNumber](_type_blocknumber_.blocknumber.md) @@ -221,7 +221,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -264,7 +264,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -285,7 +285,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -377,7 +377,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -411,7 +411,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -428,7 +428,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -464,7 +464,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_validatorprefs_.validatorprefs.md b/docs/types/classes/_type_validatorprefs_.validatorprefs.md index a939eaeb7c..93598a7aa3 100644 --- a/docs/types/classes/_type_validatorprefs_.validatorprefs.md +++ b/docs/types/classes/_type_validatorprefs_.validatorprefs.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/ValidatorPrefs.ts:22](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ValidatorPrefs.ts#L22)* +*Defined in [type/ValidatorPrefs.ts:22](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ValidatorPrefs.ts#L22)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -91,7 +91,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -106,7 +106,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -119,7 +119,7 @@ ___ getunstakeThreshold(): [U32](_primitive_u32_.u32.md) -*Defined in [type/ValidatorPrefs.ts:33](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ValidatorPrefs.ts#L33)* +*Defined in [type/ValidatorPrefs.ts:33](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ValidatorPrefs.ts#L33)* *__description__*: The unstake threshold as [U32](_primitive_u32_.u32.md) @@ -132,7 +132,7 @@ ___ getvalidatorPayment(): [Compact](_codec_compact_.compact.md) -*Defined in [type/ValidatorPrefs.ts:40](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ValidatorPrefs.ts#L40)* +*Defined in [type/ValidatorPrefs.ts:40](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ValidatorPrefs.ts#L40)* *__description__*: The payment config for the validator as a [Compact](_codec_compact_.compact.md) [Balance](_type_balance_.balance.md) @@ -214,7 +214,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -257,7 +257,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -278,7 +278,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -353,7 +353,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -370,7 +370,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -387,7 +387,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -404,7 +404,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -421,7 +421,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -457,7 +457,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_vestingschedule_.vestingschedule.md b/docs/types/classes/_type_vestingschedule_.vestingschedule.md index 6533258c8f..793d5a864b 100644 --- a/docs/types/classes/_type_vestingschedule_.vestingschedule.md +++ b/docs/types/classes/_type_vestingschedule_.vestingschedule.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [type/VestingSchedule.ts:12](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/VestingSchedule.ts#L12)* +*Defined in [type/VestingSchedule.ts:12](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/VestingSchedule.ts#L12)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L160)* +*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L160)* *__description__*: Returns the Type description to sthe structure @@ -91,7 +91,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L167)* +*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L167)* *__description__*: The length of the value when encoded as a Uint8Array @@ -106,7 +106,7 @@ getisEmpty(): `boolean` *Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L145)* +*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L145)* *__description__*: Checks if the value is an empty value @@ -119,7 +119,7 @@ ___ getoffset(): [Balance](_type_balance_.balance.md) -*Defined in [type/VestingSchedule.ts:23](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/VestingSchedule.ts#L23)* +*Defined in [type/VestingSchedule.ts:23](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/VestingSchedule.ts#L23)* *__description__*: The offset as [Balance](_type_balance_.balance.md) @@ -132,7 +132,7 @@ ___ getperBlock(): [Balance](_type_balance_.balance.md) -*Defined in [type/VestingSchedule.ts:30](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/VestingSchedule.ts#L30)* +*Defined in [type/VestingSchedule.ts:30](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/VestingSchedule.ts#L30)* *__description__*: The perBlock value as [Balance](_type_balance_.balance.md) @@ -214,7 +214,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L176)* +*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L176)* *__description__*: Compares the value of the input to see if there is a match @@ -257,7 +257,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L184)* +*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L184)* *__description__*: Returns a specific names entry in the structure @@ -278,7 +278,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L191)* +*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L191)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -353,7 +353,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L198)* +*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L198)* *__description__*: Converts the Object to an standard JavaScript Array @@ -370,7 +370,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L205)* +*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L205)* *__description__*: Returns a hex string representation of the value @@ -387,7 +387,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L212)* +*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L212)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -404,7 +404,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L226)* +*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L226)* *__description__*: Returns the string representation of the value @@ -421,7 +421,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L234)* +*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L234)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -457,7 +457,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Struct.ts#L125)* +*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Struct.ts#L125)* **Type parameters:** diff --git a/docs/types/classes/_type_vote_.vote.md b/docs/types/classes/_type_vote_.vote.md index 7b93f6edfe..1cefd40dd4 100644 --- a/docs/types/classes/_type_vote_.vote.md +++ b/docs/types/classes/_type_vote_.vote.md @@ -24,7 +24,7 @@ *Overrides [I8](_primitive_i8_.i8.md).[constructor](_primitive_i8_.i8.md#constructor)* -*Defined in [type/Vote.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Vote.ts#L14)* +*Defined in [type/Vote.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Vote.ts#L14)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -59,7 +59,7 @@ ___ getisAye(): `boolean` -*Defined in [type/Vote.ts:32](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Vote.ts#L32)* +*Defined in [type/Vote.ts:32](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Vote.ts#L32)* *__description__*: true is the wrapped value is a positive vote @@ -74,7 +74,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -87,7 +87,7 @@ ___ getisNay(): `boolean` -*Defined in [type/Vote.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Vote.ts#L39)* +*Defined in [type/Vote.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Vote.ts#L39)* *__description__*: true is the wrapped value is a negative vote @@ -227,7 +227,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -402,7 +402,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1566,7 +1566,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1607,7 +1607,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1626,7 +1626,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1679,7 +1679,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1725,7 +1725,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1929,7 +1929,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_type_voteindex_.voteindex.md b/docs/types/classes/_type_voteindex_.voteindex.md index 61a1c756b4..5c76032d51 100644 --- a/docs/types/classes/_type_voteindex_.voteindex.md +++ b/docs/types/classes/_type_voteindex_.voteindex.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/U32.ts#L14)* +*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/U32.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L64)* +*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -63,7 +63,7 @@ getisEmpty(): `boolean` *Inherited from AbstractInt.isEmpty* -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L71)* +*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L71)* *__description__*: Checks if the value is a zero value (align elsewhere) @@ -203,7 +203,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L78)* +*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L78)* *__description__*: Returns the number of bits in the value @@ -378,7 +378,7 @@ ___ *Overrides BN.eq* -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L85)* +*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L85)* *__description__*: Compares the value of the input to see if there is a match @@ -1542,7 +1542,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L98)* +*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L98)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1583,7 +1583,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1602,7 +1602,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L110)* +*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L110)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1655,7 +1655,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L121)* +*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L121)* *__description__*: Returns the string representation of the value @@ -1701,7 +1701,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1905,7 +1905,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/AbstractInt.ts#L39)* +*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L39)* **Parameters:** diff --git a/docs/types/classes/_type_votethreshold_.votethreshold.md b/docs/types/classes/_type_votethreshold_.votethreshold.md index b36fed5d94..9eeab017f7 100644 --- a/docs/types/classes/_type_votethreshold_.votethreshold.md +++ b/docs/types/classes/_type_votethreshold_.votethreshold.md @@ -24,7 +24,7 @@ *Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* -*Defined in [type/VoteThreshold.ts:12](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/VoteThreshold.ts#L12)* +*Defined in [type/VoteThreshold.ts:12](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/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/1c6a89b/packages/types/src/codec/Enum.ts#L64)* +*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -61,7 +61,7 @@ getisEmpty(): `boolean` *Inherited from [Enum](_codec_enum_.enum.md).[isEmpty](_codec_enum_.enum.md#isempty)* -*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L71)* +*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L71)* *__description__*: Checks if the value is an empty value (always false) @@ -81,7 +81,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[eq](_codec_enum_.enum.md#eq)* -*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L78)* +*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L78)* *__description__*: Compares the value of the input to see if there is a match @@ -104,7 +104,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toHex](_codec_enum_.enum.md#tohex)* -*Defined in [codec/Enum.ts:91](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L91)* +*Defined in [codec/Enum.ts:91](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L91)* *__description__*: Returns a hex string representation of the value @@ -121,7 +121,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toJSON](_codec_enum_.enum.md#tojson)* -*Defined in [codec/Enum.ts:98](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L98)* +*Defined in [codec/Enum.ts:98](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L98)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -136,7 +136,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* -*Defined in [codec/Enum.ts:105](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L105)* +*Defined in [codec/Enum.ts:105](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L105)* *__description__*: Returns the number representation for the value @@ -153,7 +153,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toString](_codec_enum_.enum.md#tostring)* -*Defined in [codec/Enum.ts:112](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L112)* +*Defined in [codec/Enum.ts:112](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L112)* *__description__*: Returns the string representation of the value @@ -170,7 +170,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toU8a](_codec_enum_.enum.md#tou8a)* -*Defined in [codec/Enum.ts:120](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/Enum.ts#L120)* +*Defined in [codec/Enum.ts:120](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/Enum.ts#L120)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -191,7 +191,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/1c6a89b/packages/types/src/codec/Enum.ts#L47)* +*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/6eb859c/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 c68d95d388..316a703e29 100644 --- a/docs/types/enums/_codec_createtype_.typedefinfo.md +++ b/docs/types/enums/_codec_createtype_.typedefinfo.md @@ -22,7 +22,7 @@ **Compact**: -*Defined in [codec/createType.ts:19](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/createType.ts#L19)* +*Defined in [codec/createType.ts:19](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/createType.ts#L19)* ___ @@ -31,7 +31,7 @@ ___ **Enum**: -*Defined in [codec/createType.ts:20](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/createType.ts#L20)* +*Defined in [codec/createType.ts:20](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/createType.ts#L20)* ___ @@ -40,7 +40,7 @@ ___ **Option**: -*Defined in [codec/createType.ts:21](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/createType.ts#L21)* +*Defined in [codec/createType.ts:21](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/createType.ts#L21)* ___ @@ -49,7 +49,7 @@ ___ **Plain**: -*Defined in [codec/createType.ts:22](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/createType.ts#L22)* +*Defined in [codec/createType.ts:22](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/createType.ts#L22)* ___ @@ -58,7 +58,7 @@ ___ **Struct**: -*Defined in [codec/createType.ts:23](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/createType.ts#L23)* +*Defined in [codec/createType.ts:23](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/createType.ts#L23)* ___ @@ -67,7 +67,7 @@ ___ **Tuple**: -*Defined in [codec/createType.ts:24](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/createType.ts#L24)* +*Defined in [codec/createType.ts:24](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/createType.ts#L24)* ___ @@ -76,7 +76,7 @@ ___ **Vector**: -*Defined in [codec/createType.ts:25](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/createType.ts#L25)* +*Defined in [codec/createType.ts:25](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/createType.ts#L25)* ___ diff --git a/docs/types/index.html b/docs/types/index.html index 146ef5ac9d..096205fb7a 100644 --- a/docs/types/index.html +++ b/docs/types/index.html @@ -2184,7 +2184,7 @@ diff --git a/docs/types/interfaces/_metadata_types_.metadatainterface.md b/docs/types/interfaces/_metadata_types_.metadatainterface.md index aa998d08e2..8635085050 100644 --- a/docs/types/interfaces/_metadata_types_.metadatainterface.md +++ b/docs/types/interfaces/_metadata_types_.metadatainterface.md @@ -19,7 +19,7 @@ ▸ **getUniqTypes**(): `Array`<`string`> -*Defined in [Metadata/types.ts:6](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/types.ts#L6)* +*Defined in [Metadata/types.ts:6](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/types.ts#L6)* **Returns:** `Array`<`string`> diff --git a/docs/types/interfaces/_primitive_method_.methodfunction.md b/docs/types/interfaces/_primitive_method_.methodfunction.md index fd136296d9..cdded9b486 100644 --- a/docs/types/interfaces/_primitive_method_.methodfunction.md +++ b/docs/types/interfaces/_primitive_method_.methodfunction.md @@ -7,7 +7,7 @@ # Callable ▸ **__call**(...args: *`any`[]*): [Method](../classes/_primitive_method_.method.md) -*Defined in [primitive/Method.ts:28](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L28)* +*Defined in [primitive/Method.ts:28](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L28)* **Parameters:** @@ -25,7 +25,7 @@ **● callIndex**: *`Uint8Array`* -*Defined in [primitive/Method.ts:30](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L30)* +*Defined in [primitive/Method.ts:30](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L30)* ___ @@ -34,7 +34,7 @@ ___ **● meta**: *[FunctionMetadata](../classes/_metadata_v0_modules_.functionmetadata.md)* -*Defined in [primitive/Method.ts:31](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L31)* +*Defined in [primitive/Method.ts:31](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L31)* ___ @@ -43,7 +43,7 @@ ___ **● method**: *`string`* -*Defined in [primitive/Method.ts:32](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L32)* +*Defined in [primitive/Method.ts:32](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L32)* ___ @@ -52,7 +52,7 @@ ___ **● section**: *`string`* -*Defined in [primitive/Method.ts:33](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L33)* +*Defined in [primitive/Method.ts:33](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L33)* ___ @@ -61,7 +61,7 @@ ___ **● toJSON**: *`function`* -*Defined in [primitive/Method.ts:34](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/Method.ts#L34)* +*Defined in [primitive/Method.ts:34](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/Method.ts#L34)* #### Type declaration ▸(): `any` diff --git a/docs/types/interfaces/_primitive_storagekey_.storagefunction.md b/docs/types/interfaces/_primitive_storagekey_.storagefunction.md index 049e5fc392..15b8ad494e 100644 --- a/docs/types/interfaces/_primitive_storagekey_.storagefunction.md +++ b/docs/types/interfaces/_primitive_storagekey_.storagefunction.md @@ -7,7 +7,7 @@ # Callable ▸ **__call**(arg?: *`any`*): `Uint8Array` -*Defined in [primitive/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/StorageKey.ts#L12)* +*Defined in [primitive/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/StorageKey.ts#L12)* **Parameters:** @@ -25,7 +25,7 @@ **● meta**: *[StorageFunctionMetadata](../classes/_metadata_v0_modules_.storagefunctionmetadata.md)* -*Defined in [primitive/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/StorageKey.ts#L14)* +*Defined in [primitive/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/StorageKey.ts#L14)* ___ @@ -34,7 +34,7 @@ ___ **● method**: *`string`* -*Defined in [primitive/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/StorageKey.ts#L15)* +*Defined in [primitive/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/StorageKey.ts#L15)* ___ @@ -43,7 +43,7 @@ ___ **● section**: *`string`* -*Defined in [primitive/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/StorageKey.ts#L16)* +*Defined in [primitive/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/StorageKey.ts#L16)* ___ @@ -52,7 +52,7 @@ ___ **● toJSON**: *`function`* -*Defined in [primitive/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/primitive/StorageKey.ts#L17)* +*Defined in [primitive/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/primitive/StorageKey.ts#L17)* #### Type declaration ▸(): `any` diff --git a/docs/types/interfaces/_types_.codec.md b/docs/types/interfaces/_types_.codec.md index abaa22f470..d4abeca358 100644 --- a/docs/types/interfaces/_types_.codec.md +++ b/docs/types/interfaces/_types_.codec.md @@ -191,7 +191,7 @@ **● encodedLength**: *`number`* -*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L34)* +*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L34)* *__description__*: The length of the value when encoded as a Uint8Array @@ -202,7 +202,7 @@ ___ **● isEmpty**: *`boolean`* -*Defined in [types.ts:39](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L39)* +*Defined in [types.ts:39](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L39)* *__description__*: Checks if the value is an empty value @@ -216,7 +216,7 @@ ___ ▸ **eq**(other?: *`any`*): `boolean` -*Defined in [types.ts:44](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L44)* +*Defined in [types.ts:44](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L44)* *__description__*: Compares the value of the input to see if there is a match @@ -235,7 +235,7 @@ ___ ▸ **toHex**(): `string` -*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L49)* +*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L49)* *__description__*: Returns a hex string representation of the value @@ -248,7 +248,7 @@ ___ ▸ **toJSON**(): `any` -*Defined in [types.ts:54](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L54)* +*Defined in [types.ts:54](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L54)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -261,7 +261,7 @@ ___ ▸ **toString**(): `string` -*Defined in [types.ts:59](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L59)* +*Defined in [types.ts:59](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L59)* *__description__*: Returns the string representation of the value @@ -274,7 +274,7 @@ ___ ▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` -*Defined in [types.ts:65](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L65)* +*Defined in [types.ts:65](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L65)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/interfaces/_types_.constructor.md b/docs/types/interfaces/_types_.constructor.md index 7aba17d70d..6de7680718 100644 --- a/docs/types/interfaces/_types_.constructor.md +++ b/docs/types/interfaces/_types_.constructor.md @@ -14,7 +14,7 @@ ⊕ **new Constructor**(...value: *`Array`<`any`>*): `T` -*Defined in [types.ts:70](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L70)* +*Defined in [types.ts:70](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L70)* **Parameters:** diff --git a/docs/types/interfaces/_types_.runtimeversioninterface.md b/docs/types/interfaces/_types_.runtimeversioninterface.md index a37c71ff1f..ad563ef55c 100644 --- a/docs/types/interfaces/_types_.runtimeversioninterface.md +++ b/docs/types/interfaces/_types_.runtimeversioninterface.md @@ -16,7 +16,7 @@ **● apis**: *`Array`<`any`>* -*Defined in [types.ts:83](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L83)* +*Defined in [types.ts:83](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L83)* ___ @@ -25,7 +25,7 @@ ___ **● authoringVersion**: *`BN`* -*Defined in [types.ts:84](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L84)* +*Defined in [types.ts:84](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L84)* ___ @@ -34,7 +34,7 @@ ___ **● implName**: *`String`* -*Defined in [types.ts:85](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L85)* +*Defined in [types.ts:85](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L85)* ___ @@ -43,7 +43,7 @@ ___ **● implVersion**: *`BN`* -*Defined in [types.ts:86](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L86)* +*Defined in [types.ts:86](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L86)* ___ @@ -52,7 +52,7 @@ ___ **● specName**: *`String`* -*Defined in [types.ts:87](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L87)* +*Defined in [types.ts:87](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L87)* ___ @@ -61,7 +61,7 @@ ___ **● specVersion**: *`BN`* -*Defined in [types.ts:88](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L88)* +*Defined in [types.ts:88](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L88)* ___ diff --git a/docs/types/modules/_classes_.md b/docs/types/modules/_classes_.md index 5a4ea30ffd..9976bf5dbc 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/1c6a89b/packages/types/src/classes.ts#L7)* +*Defined in [classes.ts:7](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/classes.ts#L7)* ___ diff --git a/docs/types/modules/_codec_abstractint_.md b/docs/types/modules/_codec_abstractint_.md index 3751b32ec5..ed92e06c78 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/1c6a89b/packages/types/src/codec/AbstractInt.ts#L10)* +*Defined in [codec/AbstractInt.ts:10](https://github.com/polkadot-js/api/blob/6eb859c/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/1c6a89b/packages/types/src/codec/AbstractInt.ts#L12)* +*Defined in [codec/AbstractInt.ts:12](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/AbstractInt.ts#L12)* ___ diff --git a/docs/types/modules/_codec_createtype_.md b/docs/types/modules/_codec_createtype_.md index 3a5100171d..9c1d878213 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:28](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/createType.ts#L28)* +*Defined in [codec/createType.ts:28](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/createType.ts#L28)* #### Type declaration @@ -42,7 +42,7 @@ ___ ▸ **createClass**(type: *[Text](../classes/_primitive_text_.text.md) \| `string`*, value?: *`any`*): [Constructor](../interfaces/_types_.constructor.md) -*Defined in [codec/createType.ts:195](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/createType.ts#L195)* +*Defined in [codec/createType.ts:195](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/createType.ts#L195)* **Parameters:** @@ -60,7 +60,7 @@ ___ ▸ **createType**(type: *[Text](../classes/_primitive_text_.text.md) \| `string`*, value?: *`any`*): [Codec](../interfaces/_types_.codec.md) -*Defined in [codec/createType.ts:201](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/createType.ts#L201)* +*Defined in [codec/createType.ts:201](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/createType.ts#L201)* **Parameters:** @@ -78,7 +78,7 @@ ___ ▸ **getTypeClass**(value: *[TypeDef](_codec_createtype_.md#typedef)*): [Constructor](../interfaces/_types_.constructor.md) -*Defined in [codec/createType.ts:139](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/createType.ts#L139)* +*Defined in [codec/createType.ts:139](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/createType.ts#L139)* **Parameters:** @@ -95,7 +95,7 @@ ___ ▸ **getTypeDef**(_type: *[Text](../classes/_primitive_text_.text.md) \| `string`*, name?: *`undefined` \| `string`*): [TypeDef](_codec_createtype_.md#typedef) -*Defined in [codec/createType.ts:84](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/createType.ts#L84)* +*Defined in [codec/createType.ts:84](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/createType.ts#L84)* **Parameters:** @@ -113,7 +113,7 @@ ___ ▸ **typeSplit**(type: *`string`*): `Array`<`string`> -*Defined in [codec/createType.ts:36](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/createType.ts#L36)* +*Defined in [codec/createType.ts:36](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/createType.ts#L36)* **Parameters:** diff --git a/docs/types/modules/_codec_utils_comparearray_.md b/docs/types/modules/_codec_utils_comparearray_.md index c3d0140563..95b4456d1e 100644 --- a/docs/types/modules/_codec_utils_comparearray_.md +++ b/docs/types/modules/_codec_utils_comparearray_.md @@ -8,7 +8,7 @@ ▸ **compareArray**(a: *`Array`<`any`>*, b?: *`any`*): `boolean` -*Defined in [codec/utils/compareArray.ts:9](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/utils/compareArray.ts#L9)* +*Defined in [codec/utils/compareArray.ts:9](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/utils/compareArray.ts#L9)* **Parameters:** diff --git a/docs/types/modules/_codec_utils_comparemap_.md b/docs/types/modules/_codec_utils_comparemap_.md index ef0ad71d06..511251151f 100644 --- a/docs/types/modules/_codec_utils_comparemap_.md +++ b/docs/types/modules/_codec_utils_comparemap_.md @@ -8,7 +8,7 @@ ▸ **compareMap**(a: *`Map`<`any`, `any`>*, b?: *`any`*): `boolean` -*Defined in [codec/utils/compareMap.ts:9](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/utils/compareMap.ts#L9)* +*Defined in [codec/utils/compareMap.ts:9](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/codec/utils/compareMap.ts#L9)* **Parameters:** diff --git a/docs/types/modules/_codec_utils_decodeu8a_.md b/docs/types/modules/_codec_utils_decodeu8a_.md index 4cdb8edf49..7682c44068 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](../interfaces/_types_.constructor.md)[] \| `object`*): [Codec](../interfaces/_types_.codec.md)[] -*Defined in [codec/utils/decodeU8a.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/codec/utils/decodeU8a.ts#L14)* +*Defined in [codec/utils/decodeU8a.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/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/_metadata_magicnumber_.md b/docs/types/modules/_metadata_magicnumber_.md index c613452587..5b98bb07b1 100644 --- a/docs/types/modules/_metadata_magicnumber_.md +++ b/docs/types/modules/_metadata_magicnumber_.md @@ -21,7 +21,7 @@ **● MAGIC_ERROR**: *`-61746`* = -61746 -*Defined in [Metadata/MagicNumber.ts:9](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/MagicNumber.ts#L9)* +*Defined in [Metadata/MagicNumber.ts:9](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/MagicNumber.ts#L9)* ___ @@ -30,7 +30,7 @@ ___ **● MAGIC_NUMBER**: *[U32](../classes/_primitive_u32_.u32.md)* = new U32(0x6174656d) -*Defined in [Metadata/MagicNumber.ts:8](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/MagicNumber.ts#L8)* +*Defined in [Metadata/MagicNumber.ts:8](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/MagicNumber.ts#L8)* ___ diff --git a/docs/types/modules/_metadata_util_flattenuniq_.md b/docs/types/modules/_metadata_util_flattenuniq_.md index 0ca59ccc97..e2831ea7ff 100644 --- a/docs/types/modules/_metadata_util_flattenuniq_.md +++ b/docs/types/modules/_metadata_util_flattenuniq_.md @@ -8,7 +8,7 @@ ▸ **flattenUniq**(list: *`Array`<`any`>*): `Array`<`any`> -*Defined in [Metadata/util/flattenUniq.ts:6](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/util/flattenUniq.ts#L6)* +*Defined in [Metadata/util/flattenUniq.ts:6](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/util/flattenUniq.ts#L6)* **Parameters:** diff --git a/docs/types/modules/_metadata_util_validatetypes_.md b/docs/types/modules/_metadata_util_validatetypes_.md index 25cb591e37..046a18148e 100644 --- a/docs/types/modules/_metadata_util_validatetypes_.md +++ b/docs/types/modules/_metadata_util_validatetypes_.md @@ -8,7 +8,7 @@ ▸ **validateTypes**(types: *`Array`<`string`>*): `void` -*Defined in [Metadata/util/validateTypes.ts:10](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/util/validateTypes.ts#L10)* +*Defined in [Metadata/util/validateTypes.ts:10](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/util/validateTypes.ts#L10)* **Parameters:** diff --git a/docs/types/modules/_metadata_v1_tov0_.md b/docs/types/modules/_metadata_v1_tov0_.md index 493493e28f..feadfbba7c 100644 --- a/docs/types/modules/_metadata_v1_tov0_.md +++ b/docs/types/modules/_metadata_v1_tov0_.md @@ -8,7 +8,7 @@ ▸ **toV0**(v1: *[MetadataV1](../classes/_metadata_v1_index_.metadatav1.md)*): [MetadataV0](../classes/_metadata_v0_index_.metadatav0.md) -*Defined in [Metadata/v1/toV0.ts:96](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/Metadata/v1/toV0.ts#L96)* +*Defined in [Metadata/v1/toV0.ts:96](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/Metadata/v1/toV0.ts#L96)* **Parameters:** diff --git a/docs/types/modules/_type_accountindex_.md b/docs/types/modules/_type_accountindex_.md index 4056031955..c95d420111 100644 --- a/docs/types/modules/_type_accountindex_.md +++ b/docs/types/modules/_type_accountindex_.md @@ -20,7 +20,7 @@ **● ENUMSET_SIZE**: *`BN`* = new BN(64) -*Defined in [type/AccountIndex.ts:12](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/AccountIndex.ts#L12)* +*Defined in [type/AccountIndex.ts:12](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/AccountIndex.ts#L12)* ___ diff --git a/docs/types/modules/_type_address_.md b/docs/types/modules/_type_address_.md index 4d3463b0dd..5330d71e93 100644 --- a/docs/types/modules/_type_address_.md +++ b/docs/types/modules/_type_address_.md @@ -20,7 +20,7 @@ **● ACCOUNT_ID_PREFIX**: *`Uint8Array`* = new Uint8Array([0xff]) -*Defined in [type/Address.ts:16](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Address.ts#L16)* +*Defined in [type/Address.ts:16](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Address.ts#L16)* ___ diff --git a/docs/types/modules/_type_bft_.md b/docs/types/modules/_type_bft_.md index fa00fa5d3d..67c1caa6d4 100644 --- a/docs/types/modules/_type_bft_.md +++ b/docs/types/modules/_type_bft_.md @@ -22,7 +22,7 @@ **Ƭ BftAuthoritySignatureValue**: *[[AnyU8a](_types_.md#anyu8a), [AnyU8a](_types_.md#anyu8a)]* -*Defined in [type/Bft.ts:12](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Bft.ts#L12)* +*Defined in [type/Bft.ts:12](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Bft.ts#L12)* ___ @@ -31,7 +31,7 @@ ___ **Ƭ BftHashSignatureValue**: *[[AnyU8a](_types_.md#anyu8a), [AnyU8a](_types_.md#anyu8a)]* -*Defined in [type/Bft.ts:43](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Bft.ts#L43)* +*Defined in [type/Bft.ts:43](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Bft.ts#L43)* ___ diff --git a/docs/types/modules/_type_block_.md b/docs/types/modules/_type_block_.md index 39d61879a2..60f661f311 100644 --- a/docs/types/modules/_type_block_.md +++ b/docs/types/modules/_type_block_.md @@ -20,7 +20,7 @@ **Ƭ BlockValue**: *`object`* -*Defined in [type/Block.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Block.ts#L14)* +*Defined in [type/Block.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Block.ts#L14)* #### Type declaration diff --git a/docs/types/modules/_type_extrinsicsignature_.md b/docs/types/modules/_type_extrinsicsignature_.md index ac3d008965..7ed5410127 100644 --- a/docs/types/modules/_type_extrinsicsignature_.md +++ b/docs/types/modules/_type_extrinsicsignature_.md @@ -20,7 +20,7 @@ **● IMMORTAL_ERA**: *`Uint8Array`* = new Uint8Array([0]) -*Defined in [type/ExtrinsicSignature.ts:18](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/ExtrinsicSignature.ts#L18)* +*Defined in [type/ExtrinsicSignature.ts:18](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/ExtrinsicSignature.ts#L18)* ___ diff --git a/docs/types/modules/_type_header_.md b/docs/types/modules/_type_header_.md index f96dd2cbae..356284400e 100644 --- a/docs/types/modules/_type_header_.md +++ b/docs/types/modules/_type_header_.md @@ -21,7 +21,7 @@ **Ƭ HeaderValue**: *`object`* -*Defined in [type/Header.ts:17](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Header.ts#L17)* +*Defined in [type/Header.ts:17](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Header.ts#L17)* #### Type declaration diff --git a/docs/types/modules/_type_justification_.md b/docs/types/modules/_type_justification_.md index 88bb55abc2..0274a45689 100644 --- a/docs/types/modules/_type_justification_.md +++ b/docs/types/modules/_type_justification_.md @@ -21,7 +21,7 @@ **Ƭ RhdJustificationValue**: *`object`* -*Defined in [type/Justification.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/Justification.ts#L14)* +*Defined in [type/Justification.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/Justification.ts#L14)* #### Type declaration diff --git a/docs/types/modules/_type_keyvalue_.md b/docs/types/modules/_type_keyvalue_.md index b423565c0c..03fb3820cc 100644 --- a/docs/types/modules/_type_keyvalue_.md +++ b/docs/types/modules/_type_keyvalue_.md @@ -21,7 +21,7 @@ **Ƭ KeyValueOptionValue**: *[[AnyU8a](_types_.md#anyu8a), `undefined` \| `string` \| `Uint8Array` \| `number`[]]* -*Defined in [type/KeyValue.ts:49](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/KeyValue.ts#L49)* +*Defined in [type/KeyValue.ts:49](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/KeyValue.ts#L49)* ___ diff --git a/docs/types/modules/_type_storedpendingchange_.md b/docs/types/modules/_type_storedpendingchange_.md index 94dbd34c4d..7ade46a097 100644 --- a/docs/types/modules/_type_storedpendingchange_.md +++ b/docs/types/modules/_type_storedpendingchange_.md @@ -22,7 +22,7 @@ **Ƭ NextAuthorityValue**: *`object`* -*Defined in [type/StoredPendingChange.ts:14](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/StoredPendingChange.ts#L14)* +*Defined in [type/StoredPendingChange.ts:14](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/StoredPendingChange.ts#L14)* #### Type declaration @@ -33,7 +33,7 @@ ___ **Ƭ StoredPendingChangeValue**: *`object`* -*Defined in [type/StoredPendingChange.ts:19](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/type/StoredPendingChange.ts#L19)* +*Defined in [type/StoredPendingChange.ts:19](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/type/StoredPendingChange.ts#L19)* #### Type declaration diff --git a/docs/types/modules/_types_.md b/docs/types/modules/_types_.md index 233e2ec687..b510d1d7bc 100644 --- a/docs/types/modules/_types_.md +++ b/docs/types/modules/_types_.md @@ -31,7 +31,7 @@ **Ƭ AnyNumber**: *`BN` \| `Uint8Array` \| `number` \| `string`* -*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L17)* ___ @@ -40,7 +40,7 @@ ___ **Ƭ AnyString**: *`string` \| `String`* -*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L19)* ___ @@ -49,7 +49,7 @@ ___ **Ƭ AnyU8a**: *`Uint8Array` \| `Array`<`number`> \| `string`* -*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L21)* ___ @@ -58,7 +58,7 @@ ___ **Ƭ CodecArg**: *[Codec](../interfaces/_types_.codec.md) \| `BN` \| `Boolean` \| `String` \| `Uint8Array` \| `boolean` \| `number` \| `string` \| `undefined` \| `CodecArgArray` \| `CodecArgObject`* -*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L7)* ___ @@ -67,7 +67,7 @@ ___ **Ƭ CodecCallback**: *`function`* -*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L9)* #### Type declaration ▸(result: *`T`*): `any` @@ -87,7 +87,7 @@ ___ **Ƭ CodecTo**: *"toHex" \| "toJSON" \| "toString" \| "toU8a"* -*Defined in [types.ts:68](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L68)* +*Defined in [types.ts:68](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L68)* ___ @@ -96,7 +96,7 @@ ___ **Ƭ ConstructorDef**: *`object`* -*Defined in [types.ts:74](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L74)* +*Defined in [types.ts:74](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L74)* #### Type declaration @@ -109,7 +109,7 @@ ___ **Ƭ RegistryTypes**: *`object`* -*Defined in [types.ts:78](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L78)* +*Defined in [types.ts:78](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L78)* #### Type declaration @@ -122,7 +122,7 @@ ___ **Ƭ SignatureOptions**: *`object`* -*Defined in [types.ts:91](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L91)* +*Defined in [types.ts:91](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L91)* #### Type declaration @@ -133,7 +133,7 @@ ___ **Ƭ TypeDef**: *`object`* -*Defined in [types.ts:76](https://github.com/polkadot-js/api/blob/1c6a89b/packages/types/src/types.ts#L76)* +*Defined in [types.ts:76](https://github.com/polkadot-js/api/blob/6eb859c/packages/types/src/types.ts#L76)* #### Type declaration diff --git a/lerna.json b/lerna.json index aaa3a6dd90..dbcba6d146 100644 --- a/lerna.json +++ b/lerna.json @@ -9,5 +9,5 @@ "packages": [ "packages/*" ], - "version": "0.45.3" + "version": "0.45.4" } diff --git a/package.json b/package.json index 7c7b2db043..7f0490dc3a 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "version": "0.45.3", + "version": "0.45.4", "private": true, "engines": { "node": ">=10.13.0", diff --git a/packages/api-derive/package.json b/packages/api-derive/package.json index 8ca5c0f7d4..df81d61fb2 100644 --- a/packages/api-derive/package.json +++ b/packages/api-derive/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/api-derive", - "version": "0.45.3", + "version": "0.45.4", "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.3.1", - "@polkadot/api": "^0.45.3", - "@polkadot/types": "^0.45.3", + "@polkadot/api": "^0.45.4", + "@polkadot/types": "^0.45.4", "@types/memoizee": "^0.4.2", "memoizee": "^0.4.14" } diff --git a/packages/api/package.json b/packages/api/package.json index 6501f85b5a..e44d50daee 100644 --- a/packages/api/package.json +++ b/packages/api/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/api", - "version": "0.45.3", + "version": "0.45.4", "description": "Promise and RxJS wrappers 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.3.1", - "@polkadot/api-derive": "^0.45.3", - "@polkadot/extrinsics": "^0.45.3", - "@polkadot/rpc-provider": "^0.45.3", - "@polkadot/rpc-rx": "^0.45.3", - "@polkadot/storage": "^0.45.3", - "@polkadot/types": "^0.45.3", + "@polkadot/api-derive": "^0.45.4", + "@polkadot/extrinsics": "^0.45.4", + "@polkadot/rpc-provider": "^0.45.4", + "@polkadot/rpc-rx": "^0.45.4", + "@polkadot/storage": "^0.45.4", + "@polkadot/types": "^0.45.4", "@polkadot/util-crypto": "^0.34.21" } } diff --git a/packages/rpc-core/package.json b/packages/rpc-core/package.json index 07c3af7f57..f3da3c11fe 100644 --- a/packages/rpc-core/package.json +++ b/packages/rpc-core/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-core", - "version": "0.45.3", + "version": "0.45.4", "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.3.1", - "@polkadot/jsonrpc": "^0.45.3", - "@polkadot/rpc-provider": "^0.45.3", - "@polkadot/types": "^0.45.3", + "@polkadot/jsonrpc": "^0.45.4", + "@polkadot/rpc-provider": "^0.45.4", + "@polkadot/types": "^0.45.4", "@polkadot/util": "^0.34.21" } } diff --git a/packages/rpc-provider/package.json b/packages/rpc-provider/package.json index 44451258a4..2ea2796aaa 100644 --- a/packages/rpc-provider/package.json +++ b/packages/rpc-provider/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-provider", - "version": "0.45.3", + "version": "0.45.4", "description": "Transport providers for the API", "main": "index.js", "keywords": [ @@ -31,7 +31,7 @@ "dependencies": { "@babel/runtime": "^7.3.1", "@polkadot/keyring": "^0.34.21", - "@polkadot/storage": "^0.45.3", + "@polkadot/storage": "^0.45.4", "@polkadot/util": "^0.34.21", "@polkadot/util-crypto": "^0.34.21", "@types/nock": "^9.3.1", diff --git a/packages/rpc-rx/package.json b/packages/rpc-rx/package.json index e789c36ace..0cff339b6e 100644 --- a/packages/rpc-rx/package.json +++ b/packages/rpc-rx/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-rx", - "version": "0.45.3", + "version": "0.45.4", "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.3.1", - "@polkadot/rpc-core": "^0.45.3", - "@polkadot/rpc-provider": "^0.45.3", + "@polkadot/rpc-core": "^0.45.4", + "@polkadot/rpc-provider": "^0.45.4", "@types/memoizee": "^0.4.2", "@types/rx": "^4.1.1", "memoizee": "^0.4.14", diff --git a/packages/type-extrinsics/package.json b/packages/type-extrinsics/package.json index 8aad3d4a8c..d8e3239466 100644 --- a/packages/type-extrinsics/package.json +++ b/packages/type-extrinsics/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/extrinsics", - "version": "0.45.3", + "version": "0.45.4", "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.3.1", - "@polkadot/types": "^0.45.3", + "@polkadot/types": "^0.45.4", "@polkadot/util": "^0.34.21" } } diff --git a/packages/type-jsonrpc/package.json b/packages/type-jsonrpc/package.json index cb10fddadd..500e38c647 100644 --- a/packages/type-jsonrpc/package.json +++ b/packages/type-jsonrpc/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/jsonrpc", - "version": "0.45.3", + "version": "0.45.4", "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 b4d5023da6..8e61f7c891 100644 --- a/packages/type-storage/package.json +++ b/packages/type-storage/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/storage", - "version": "0.45.3", + "version": "0.45.4", "description": "Generic wrapper wrapper around state storage", "main": "index.js", "engines": { @@ -31,7 +31,7 @@ "dependencies": { "@babel/runtime": "^7.3.1", "@polkadot/keyring": "^0.34.21", - "@polkadot/types": "^0.45.3", + "@polkadot/types": "^0.45.4", "@polkadot/util": "^0.34.21", "@polkadot/util-crypto": "^0.34.21" } diff --git a/packages/types/package.json b/packages/types/package.json index 79950f508e..fa14c78d4e 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/types", - "version": "0.45.3", + "version": "0.45.4", "description": "Implementation of the Parity codec", "main": "index.js", "keywords": [