diff --git a/docs/GLOSSARY.html b/docs/GLOSSARY.html index 4e1a54f8dd..91ed5a26d2 100644 --- a/docs/GLOSSARY.html +++ b/docs/GLOSSARY.html @@ -1993,7 +1993,7 @@ diff --git a/docs/METHODS_EVENTS.html b/docs/METHODS_EVENTS.html index 9791e35f2e..173958ac96 100644 --- a/docs/METHODS_EVENTS.html +++ b/docs/METHODS_EVENTS.html @@ -2193,7 +2193,7 @@ diff --git a/docs/METHODS_EXTRINSICS.html b/docs/METHODS_EXTRINSICS.html index bfc65bdea0..27bceb424b 100644 --- a/docs/METHODS_EXTRINSICS.html +++ b/docs/METHODS_EXTRINSICS.html @@ -2262,7 +2262,7 @@ diff --git a/docs/METHODS_RPC.html b/docs/METHODS_RPC.html index 833a37a693..c9dd03c098 100644 --- a/docs/METHODS_RPC.html +++ b/docs/METHODS_RPC.html @@ -2119,7 +2119,7 @@ diff --git a/docs/METHODS_STORAGE.html b/docs/METHODS_STORAGE.html index 5f12af56ac..5a8dd6aa20 100644 --- a/docs/METHODS_STORAGE.html +++ b/docs/METHODS_STORAGE.html @@ -2488,7 +2488,7 @@ diff --git a/docs/api-observable/classes/_base_.apibase.md b/docs/api-observable/classes/_base_.apibase.md index 67942bcf43..9e82e2b68c 100644 --- a/docs/api-observable/classes/_base_.apibase.md +++ b/docs/api-observable/classes/_base_.apibase.md @@ -14,7 +14,7 @@ ⊕ **new ApiBase**(api: *`RpcRxInterface`*): [ApiBase](_base_.apibase.md) -*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L33)* +*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L33)* **Parameters:** @@ -34,7 +34,7 @@ ___ **● whenReady**: *`Observable`<`boolean`>* -*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L33)* +*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L33)* ___ @@ -43,7 +43,7 @@ ___ **● extrinsics**: *`ModulesWithMethods`* = extrinsicsStatic -*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L41)* +*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L41)* ___ @@ -52,7 +52,7 @@ ___ **● storage**: *`Storage`* = storageStatic -*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L42)* +*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L42)* ___ @@ -64,7 +64,7 @@ ___ getgenesisHash(): `Hash` -*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L87)* +*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L87)* **Returns:** `Hash` @@ -78,7 +78,7 @@ ___ ▸ **isConnected**(): `Observable`<`boolean`> -*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L91)* +*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L91)* **Returns:** `Observable`<`boolean`> @@ -89,7 +89,7 @@ ___ ▸ **rawCall**<`T`>(__namedParameters: *`object`*, ...params: *`Array`<`any`>*): `Observable`<`T`> -*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L95)* +*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L95)* **Type parameters:** @@ -110,7 +110,7 @@ ___ ▸ **rawStorage**<`T`>(key: * `Uint8Array` | `StorageFunction`*, ...params: *`Array`<`any`>*): `Observable`< `T` | `undefined`> -*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L108)* +*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L108)* **Type parameters:** @@ -131,7 +131,7 @@ ___ ▸ **rawStorageMulti**<`T`>(...keys: *`Array`< `Uint8Array` | [`StorageFunction`] | [`StorageFunction`, `any`]>*): `Observable`<`T`> -*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L123)* +*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L123)* **Type parameters:** diff --git a/docs/api-observable/classes/_calls_.apicalls.md b/docs/api-observable/classes/_calls_.apicalls.md index f3d50a6cf4..29ca07d861 100644 --- a/docs/api-observable/classes/_calls_.apicalls.md +++ b/docs/api-observable/classes/_calls_.apicalls.md @@ -18,7 +18,7 @@ *Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L33)* +*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L33)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)* -*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L33)* +*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L33)* ___ @@ -51,7 +51,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)* -*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L41)* +*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L41)* ___ @@ -62,7 +62,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)* -*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L42)* +*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L42)* ___ @@ -76,7 +76,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* -*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L87)* +*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L87)* **Returns:** `Hash` @@ -92,7 +92,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)* -*Defined in [Queries.ts:18](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L18)* +*Defined in [Queries.ts:18](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L18)* **Parameters:** @@ -111,7 +111,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)* -*Defined in [Queries.ts:22](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L22)* +*Defined in [Queries.ts:22](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L22)* **Parameters:** @@ -130,7 +130,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)* -*Defined in [Queries.ts:26](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L26)* +*Defined in [Queries.ts:26](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L26)* **Parameters:** @@ -147,7 +147,7 @@ ___ ▸ **bestNumber**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L13)* +*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L13)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -158,7 +158,7 @@ ___ ▸ **bestNumberFinalised**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L25)* +*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L25)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -171,7 +171,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)* -*Defined in [Queries.ts:34](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L34)* +*Defined in [Queries.ts:34](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L34)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -184,7 +184,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)* -*Defined in [Queries.ts:30](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L30)* +*Defined in [Queries.ts:30](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L30)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -195,7 +195,7 @@ ___ ▸ **chain**(): `Observable`< `Text` | `undefined`> -*Defined in [Calls.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L37)* +*Defined in [Calls.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L37)* **Returns:** `Observable`< `Text` | `undefined`> @@ -206,7 +206,7 @@ ___ ▸ **chainProperties**(): `Observable`<`ChainProperties`> -*Defined in [Calls.ts:41](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L41)* +*Defined in [Calls.ts:41](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L41)* **Returns:** `Observable`<`ChainProperties`> @@ -219,7 +219,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)* -*Defined in [Queries.ts:38](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L38)* +*Defined in [Queries.ts:38](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L38)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -232,7 +232,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)* -*Defined in [Queries.ts:42](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L42)* +*Defined in [Queries.ts:42](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L42)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -245,7 +245,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)* -*Defined in [Queries.ts:125](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L125)* +*Defined in [Queries.ts:125](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L125)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -258,7 +258,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)* -*Defined in [Queries.ts:150](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L150)* +*Defined in [Queries.ts:150](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L150)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -271,7 +271,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)* -*Defined in [Queries.ts:129](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L129)* +*Defined in [Queries.ts:129](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L129)* **Returns:** `Observable`<[RxFees](../modules/_types_.md#rxfees)> @@ -284,7 +284,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[getAccountEnumSet](_queries_.apiqueries.md#getaccountenumset)* -*Defined in [Queries.ts:46](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L46)* +*Defined in [Queries.ts:46](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L46)* **Parameters:** @@ -301,7 +301,7 @@ ___ ▸ **getBlock**(hash: *`Uint8Array`*): `Observable`< `SignedBlock` | `undefined`> -*Defined in [Calls.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L53)* +*Defined in [Calls.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L53)* **Parameters:** @@ -320,7 +320,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)* -*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L91)* +*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L91)* **Returns:** `Observable`<`boolean`> @@ -333,7 +333,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[nextAccountEnumSet](_queries_.apiqueries.md#nextaccountenumset)* -*Defined in [Queries.ts:57](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L57)* +*Defined in [Queries.ts:57](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L57)* **Returns:** `Observable`< `AccountIndex` | `undefined`> @@ -346,7 +346,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)* -*Defined in [Queries.ts:61](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L61)* +*Defined in [Queries.ts:61](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L61)* **Parameters:** @@ -365,7 +365,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)* -*Defined in [Queries.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L74)* +*Defined in [Queries.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L74)* **Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> @@ -378,7 +378,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)* -*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L95)* +*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L95)* **Type parameters:** @@ -401,7 +401,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)* -*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L108)* +*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L108)* **Type parameters:** @@ -424,7 +424,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)* -*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L123)* +*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L123)* **Type parameters:** @@ -446,7 +446,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)* -*Defined in [Queries.ts:93](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L93)* +*Defined in [Queries.ts:93](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L93)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -459,7 +459,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)* -*Defined in [Queries.ts:97](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L97)* +*Defined in [Queries.ts:97](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L97)* **Parameters:** @@ -478,7 +478,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)* -*Defined in [Queries.ts:110](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L110)* +*Defined in [Queries.ts:110](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L110)* **Parameters:** @@ -498,7 +498,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)* -*Defined in [Queries.ts:114](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L114)* +*Defined in [Queries.ts:114](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L114)* **Parameters:** @@ -517,7 +517,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)* -*Defined in [Queries.ts:162](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L162)* +*Defined in [Queries.ts:162](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L162)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -530,7 +530,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)* -*Defined in [Queries.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L166)* +*Defined in [Queries.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L166)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -543,7 +543,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)* -*Defined in [Queries.ts:170](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L170)* +*Defined in [Queries.ts:170](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L170)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -556,7 +556,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)* -*Defined in [Queries.ts:174](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L174)* +*Defined in [Queries.ts:174](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L174)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -569,7 +569,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)* -*Defined in [Queries.ts:154](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L154)* +*Defined in [Queries.ts:154](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L154)* **Returns:** `Observable`< `Perbill` | `undefined`> @@ -582,7 +582,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)* -*Defined in [Queries.ts:158](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L158)* +*Defined in [Queries.ts:158](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L158)* **Returns:** `Observable`< `Balance` | `undefined`> @@ -595,7 +595,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)* -*Defined in [Queries.ts:182](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L182)* +*Defined in [Queries.ts:182](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L182)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -608,7 +608,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)* -*Defined in [Queries.ts:178](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L178)* +*Defined in [Queries.ts:178](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L178)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -621,7 +621,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)* -*Defined in [Queries.ts:193](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L193)* +*Defined in [Queries.ts:193](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L193)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -634,7 +634,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)* -*Defined in [Queries.ts:215](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L215)* +*Defined in [Queries.ts:215](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L215)* **Parameters:** @@ -653,7 +653,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)* -*Defined in [Queries.ts:204](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L204)* +*Defined in [Queries.ts:204](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L204)* **Parameters:** @@ -670,7 +670,7 @@ ___ ▸ **submitAndWatchExtrinsic**(extrinsic: *`Extrinsic`*): `Observable`< `ExtrinsicStatus` | `undefined`> -*Defined in [Calls.ts:81](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L81)* +*Defined in [Calls.ts:81](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L81)* **Parameters:** @@ -687,7 +687,7 @@ ___ ▸ **submitExtrinsic**(extrinsic: *`Extrinsic`*): `Observable`< `Hash` | `undefined`> -*Defined in [Calls.ts:77](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L77)* +*Defined in [Calls.ts:77](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L77)* **Parameters:** @@ -704,7 +704,7 @@ ___ ▸ **subscribeFinalisedHead**(): `Observable`< `Header` | `undefined`> -*Defined in [Calls.ts:57](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L57)* +*Defined in [Calls.ts:57](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L57)* **Returns:** `Observable`< `Header` | `undefined`> @@ -715,7 +715,7 @@ ___ ▸ **subscribeNewHead**(): `Observable`< `Header` | `undefined`> -*Defined in [Calls.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L63)* +*Defined in [Calls.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L63)* **Returns:** `Observable`< `Header` | `undefined`> @@ -728,7 +728,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[systemEvents](_queries_.apiqueries.md#systemevents)* -*Defined in [Queries.ts:219](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L219)* +*Defined in [Queries.ts:219](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L219)* **Returns:** `Observable`<`Array`<`EventRecord`>> @@ -739,7 +739,7 @@ ___ ▸ **systemName**(): `Observable`< `Text` | `undefined`> -*Defined in [Calls.ts:69](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L69)* +*Defined in [Calls.ts:69](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L69)* **Returns:** `Observable`< `Text` | `undefined`> @@ -750,7 +750,7 @@ ___ ▸ **systemVersion**(): `Observable`< `Text` | `undefined`> -*Defined in [Calls.ts:73](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L73)* +*Defined in [Calls.ts:73](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L73)* **Returns:** `Observable`< `Text` | `undefined`> @@ -763,7 +763,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)* -*Defined in [Queries.ts:230](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L230)* +*Defined in [Queries.ts:230](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L230)* **Returns:** `Observable`< `u32` | `undefined`> diff --git a/docs/api-observable/classes/_classes_.rxproposal.md b/docs/api-observable/classes/_classes_.rxproposal.md index 4a99af5a8f..777947dfd8 100644 --- a/docs/api-observable/classes/_classes_.rxproposal.md +++ b/docs/api-observable/classes/_classes_.rxproposal.md @@ -25,7 +25,7 @@ *Overrides Struct.__constructor* -*Defined in [classes.ts:11](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/classes.ts#L11)* +*Defined in [classes.ts:11](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/classes.ts#L11)* **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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -85,7 +85,7 @@ ___ getaddress(): `AccountId` -*Defined in [classes.ts:20](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/classes.ts#L20)* +*Defined in [classes.ts:20](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/classes.ts#L20)* **Returns:** `AccountId` @@ -98,7 +98,7 @@ getencodedLength(): `number` *Inherited from Struct.encodedLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -111,7 +111,7 @@ ___ getid(): `PropIndex` -*Defined in [classes.ts:24](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/classes.ts#L24)* +*Defined in [classes.ts:24](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/classes.ts#L24)* **Returns:** `PropIndex` @@ -122,7 +122,7 @@ ___ getproposal(): `Proposal` -*Defined in [classes.ts:28](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/classes.ts#L28)* +*Defined in [classes.ts:28](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/classes.ts#L28)* **Returns:** `Proposal` @@ -222,7 +222,7 @@ ___ *Overrides Map.get* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -243,7 +243,7 @@ ___ *Inherited from Struct.getAtIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -318,7 +318,7 @@ ___ *Inherited from Struct.toArray* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -333,7 +333,7 @@ ___ *Inherited from Struct.toHex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -348,7 +348,7 @@ ___ *Inherited from Struct.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -363,7 +363,7 @@ ___ *Inherited from Struct.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -378,7 +378,7 @@ ___ *Inherited from Struct.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -414,7 +414,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/api-observable/classes/_classes_.rxproposaldeposits.md b/docs/api-observable/classes/_classes_.rxproposaldeposits.md index 6edeba4dff..5ce3b72584 100644 --- a/docs/api-observable/classes/_classes_.rxproposaldeposits.md +++ b/docs/api-observable/classes/_classes_.rxproposaldeposits.md @@ -25,7 +25,7 @@ *Overrides Struct.__constructor* -*Defined in [classes.ts:35](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/classes.ts#L35)* +*Defined in [classes.ts:35](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/classes.ts#L35)* **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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -85,7 +85,7 @@ ___ getaddresses(): `Vector`<`AccountId`> -*Defined in [classes.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/classes.ts#L43)* +*Defined in [classes.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/classes.ts#L43)* **Returns:** `Vector`<`AccountId`> @@ -96,7 +96,7 @@ ___ getbalance(): `Balance` -*Defined in [classes.ts:47](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/classes.ts#L47)* +*Defined in [classes.ts:47](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/classes.ts#L47)* **Returns:** `Balance` @@ -109,7 +109,7 @@ getencodedLength(): `number` *Inherited from Struct.encodedLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -211,7 +211,7 @@ ___ *Overrides Map.get* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -232,7 +232,7 @@ ___ *Inherited from Struct.getAtIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -307,7 +307,7 @@ ___ *Inherited from Struct.toArray* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -322,7 +322,7 @@ ___ *Inherited from Struct.toHex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -337,7 +337,7 @@ ___ *Inherited from Struct.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -352,7 +352,7 @@ ___ *Inherited from Struct.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -367,7 +367,7 @@ ___ *Inherited from Struct.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -403,7 +403,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/api-observable/classes/_combined_.apicombined.md b/docs/api-observable/classes/_combined_.apicombined.md index b8e5dce08e..b0f7d3729b 100644 --- a/docs/api-observable/classes/_combined_.apicombined.md +++ b/docs/api-observable/classes/_combined_.apicombined.md @@ -18,7 +18,7 @@ *Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L33)* +*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L33)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)* -*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L33)* +*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L33)* ___ @@ -51,7 +51,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)* -*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L41)* +*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L41)* ___ @@ -62,7 +62,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)* -*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L42)* +*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L42)* ___ @@ -76,7 +76,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* -*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L87)* +*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L87)* **Returns:** `Hash` @@ -90,7 +90,7 @@ ___ ▸ **accountIdAndIndex**(address?: * `AccountId` | `AccountIndex` | `string` | `null`*): `Observable`<[`AccountId` | `undefined`, `AccountIndex` | `undefined`]> -*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L79)* +*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L79)* **Parameters:** @@ -107,7 +107,7 @@ ___ ▸ **accountIdFromIndex**(_accountIndex: * `AccountIndex` | `string`*): `Observable`< `AccountId` | `undefined`> -*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L53)* +*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L53)* **Parameters:** @@ -124,7 +124,7 @@ ___ ▸ **accountIndexFromId**(accountId: * `AccountId` | `string`*): `Observable`< `AccountIndex` | `undefined`> -*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L68)* +*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L68)* **Parameters:** @@ -141,7 +141,7 @@ ___ ▸ **accountIndexes**(): `Observable`<`object`> -*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L23)* +*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L23)* **Returns:** `Observable`<`object`> @@ -154,7 +154,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)* -*Defined in [Queries.ts:18](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L18)* +*Defined in [Queries.ts:18](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L18)* **Parameters:** @@ -173,7 +173,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)* -*Defined in [Queries.ts:22](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L22)* +*Defined in [Queries.ts:22](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L22)* **Parameters:** @@ -192,7 +192,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)* -*Defined in [Queries.ts:26](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L26)* +*Defined in [Queries.ts:26](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L26)* **Parameters:** @@ -211,7 +211,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)* -*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L13)* +*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L13)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -224,7 +224,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumberFinalised](_calls_.apicalls.md#bestnumberfinalised)* -*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L25)* +*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L25)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -237,7 +237,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)* -*Defined in [Queries.ts:34](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L34)* +*Defined in [Queries.ts:34](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L34)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -250,7 +250,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)* -*Defined in [Queries.ts:30](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L30)* +*Defined in [Queries.ts:30](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L30)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -263,7 +263,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[chain](_calls_.apicalls.md#chain)* -*Defined in [Calls.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L37)* +*Defined in [Calls.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L37)* **Returns:** `Observable`< `Text` | `undefined`> @@ -276,7 +276,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[chainProperties](_calls_.apicalls.md#chainproperties)* -*Defined in [Calls.ts:41](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L41)* +*Defined in [Calls.ts:41](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L41)* **Returns:** `Observable`<`ChainProperties`> @@ -289,7 +289,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)* -*Defined in [Queries.ts:38](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L38)* +*Defined in [Queries.ts:38](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L38)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -302,7 +302,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)* -*Defined in [Queries.ts:42](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L42)* +*Defined in [Queries.ts:42](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L42)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -313,7 +313,7 @@ ___ ▸ **democracyReferendumVoters**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<[RxReferendumVote](../modules/_types_.md#rxreferendumvote)>> -*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L137)* +*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L137)* **Parameters:** @@ -330,7 +330,7 @@ ___ ▸ **democracyVotersBalancesOf**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`Balance`>> -*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L182)* +*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L182)* **Parameters:** @@ -347,7 +347,7 @@ ___ ▸ **democracyVotersVotesOf**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`Bool`>> -*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L198)* +*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L198)* **Parameters:** @@ -366,7 +366,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)* -*Defined in [Queries.ts:125](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L125)* +*Defined in [Queries.ts:125](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L125)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -377,7 +377,7 @@ ___ ▸ **eraBlockLength**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L209)* +*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L209)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -388,7 +388,7 @@ ___ ▸ **eraBlockProgress**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L224)* +*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L224)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -399,7 +399,7 @@ ___ ▸ **eraBlockRemaining**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L247)* +*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L247)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -412,7 +412,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)* -*Defined in [Queries.ts:150](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L150)* +*Defined in [Queries.ts:150](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L150)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -425,7 +425,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)* -*Defined in [Queries.ts:129](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L129)* +*Defined in [Queries.ts:129](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L129)* **Returns:** `Observable`<[RxFees](../modules/_types_.md#rxfees)> @@ -438,7 +438,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[getAccountEnumSet](_queries_.apiqueries.md#getaccountenumset)* -*Defined in [Queries.ts:46](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L46)* +*Defined in [Queries.ts:46](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L46)* **Parameters:** @@ -457,7 +457,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[getBlock](_calls_.apicalls.md#getblock)* -*Defined in [Calls.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L53)* +*Defined in [Calls.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L53)* **Parameters:** @@ -476,7 +476,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)* -*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L91)* +*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L91)* **Returns:** `Observable`<`boolean`> @@ -489,7 +489,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[nextAccountEnumSet](_queries_.apiqueries.md#nextaccountenumset)* -*Defined in [Queries.ts:57](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L57)* +*Defined in [Queries.ts:57](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L57)* **Returns:** `Observable`< `AccountIndex` | `undefined`> @@ -502,7 +502,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)* -*Defined in [Queries.ts:61](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L61)* +*Defined in [Queries.ts:61](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L61)* **Parameters:** @@ -519,7 +519,7 @@ ___ ▸ **publicProposalCount**(): `Observable`<`number`> -*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L115)* +*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L115)* **Returns:** `Observable`<`number`> @@ -532,7 +532,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)* -*Defined in [Queries.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L74)* +*Defined in [Queries.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L74)* **Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> @@ -545,7 +545,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)* -*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L95)* +*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L95)* **Type parameters:** @@ -568,7 +568,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)* -*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L108)* +*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L108)* **Type parameters:** @@ -591,7 +591,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)* -*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L123)* +*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L123)* **Type parameters:** @@ -613,7 +613,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)* -*Defined in [Queries.ts:93](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L93)* +*Defined in [Queries.ts:93](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L93)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -626,7 +626,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)* -*Defined in [Queries.ts:97](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L97)* +*Defined in [Queries.ts:97](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L97)* **Parameters:** @@ -645,7 +645,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)* -*Defined in [Queries.ts:110](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L110)* +*Defined in [Queries.ts:110](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L110)* **Parameters:** @@ -665,7 +665,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)* -*Defined in [Queries.ts:114](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L114)* +*Defined in [Queries.ts:114](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L114)* **Parameters:** @@ -682,7 +682,7 @@ ___ ▸ **referendumVotes**(index: * `ReferendumIndex` | `BN` | `number`*, addresses: *`Array`< `AccountId` | `string`>*): `Observable`<`boolean`> -*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L174)* +*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L174)* **Parameters:** @@ -700,7 +700,7 @@ ___ ▸ **referendums**(): `Observable`<`Array`<`ReferendumInfo`>> -*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L153)* +*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L153)* **Returns:** `Observable`<`Array`<`ReferendumInfo`>> @@ -711,7 +711,7 @@ ___ ▸ **referendumsInfo**(referendumIds: *`Array`< `ReferendumIndex` | `BN` | `number`>*): `Observable`<`Array`<`ReferendumInfo`>> -*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L125)* +*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L125)* **Parameters:** @@ -728,7 +728,7 @@ ___ ▸ **sessionBlockProgress**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L262)* +*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L262)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -739,7 +739,7 @@ ___ ▸ **sessionBlockRemaining**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L282)* +*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L282)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -750,7 +750,7 @@ ___ ▸ **sessionBrokenValue**(): `Observable`< `Moment` | `undefined`> -*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L297)* +*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L297)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -763,7 +763,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)* -*Defined in [Queries.ts:162](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L162)* +*Defined in [Queries.ts:162](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L162)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -776,7 +776,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)* -*Defined in [Queries.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L166)* +*Defined in [Queries.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L166)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -789,7 +789,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)* -*Defined in [Queries.ts:170](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L170)* +*Defined in [Queries.ts:170](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L170)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -802,7 +802,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)* -*Defined in [Queries.ts:174](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L174)* +*Defined in [Queries.ts:174](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L174)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -815,7 +815,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)* -*Defined in [Queries.ts:154](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L154)* +*Defined in [Queries.ts:154](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L154)* **Returns:** `Observable`< `Perbill` | `undefined`> @@ -828,7 +828,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)* -*Defined in [Queries.ts:158](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L158)* +*Defined in [Queries.ts:158](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L158)* **Returns:** `Observable`< `Balance` | `undefined`> @@ -839,7 +839,7 @@ ___ ▸ **sessionTimeExpected**(): `Observable`< `Moment` | `undefined`> -*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L316)* +*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L316)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -850,7 +850,7 @@ ___ ▸ **sessionTimeRemaining**(): `Observable`< `Moment` | `undefined`> -*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L331)* +*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L331)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -863,7 +863,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)* -*Defined in [Queries.ts:182](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L182)* +*Defined in [Queries.ts:182](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L182)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -876,7 +876,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)* -*Defined in [Queries.ts:178](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L178)* +*Defined in [Queries.ts:178](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L178)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -889,7 +889,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)* -*Defined in [Queries.ts:193](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L193)* +*Defined in [Queries.ts:193](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L193)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -902,7 +902,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)* -*Defined in [Queries.ts:215](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L215)* +*Defined in [Queries.ts:215](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L215)* **Parameters:** @@ -921,7 +921,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)* -*Defined in [Queries.ts:204](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L204)* +*Defined in [Queries.ts:204](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L204)* **Parameters:** @@ -940,7 +940,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[submitAndWatchExtrinsic](_calls_.apicalls.md#submitandwatchextrinsic)* -*Defined in [Calls.ts:81](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L81)* +*Defined in [Calls.ts:81](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L81)* **Parameters:** @@ -959,7 +959,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[submitExtrinsic](_calls_.apicalls.md#submitextrinsic)* -*Defined in [Calls.ts:77](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L77)* +*Defined in [Calls.ts:77](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L77)* **Parameters:** @@ -978,7 +978,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[subscribeFinalisedHead](_calls_.apicalls.md#subscribefinalisedhead)* -*Defined in [Calls.ts:57](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L57)* +*Defined in [Calls.ts:57](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L57)* **Returns:** `Observable`< `Header` | `undefined`> @@ -991,7 +991,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[subscribeNewHead](_calls_.apicalls.md#subscribenewhead)* -*Defined in [Calls.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L63)* +*Defined in [Calls.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L63)* **Returns:** `Observable`< `Header` | `undefined`> @@ -1004,7 +1004,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[systemEvents](_queries_.apiqueries.md#systemevents)* -*Defined in [Queries.ts:219](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L219)* +*Defined in [Queries.ts:219](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L219)* **Returns:** `Observable`<`Array`<`EventRecord`>> @@ -1017,7 +1017,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[systemName](_calls_.apicalls.md#systemname)* -*Defined in [Calls.ts:69](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L69)* +*Defined in [Calls.ts:69](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L69)* **Returns:** `Observable`< `Text` | `undefined`> @@ -1030,7 +1030,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[systemVersion](_calls_.apicalls.md#systemversion)* -*Defined in [Calls.ts:73](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L73)* +*Defined in [Calls.ts:73](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L73)* **Returns:** `Observable`< `Text` | `undefined`> @@ -1041,7 +1041,7 @@ ___ ▸ **validatingBalance**(address: * `AccountId` | `string`*): `Observable`<[RxBalance](../modules/_types_.md#rxbalance)> -*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L346)* +*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L346)* **Parameters:** @@ -1058,7 +1058,7 @@ ___ ▸ **validatingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<[RxBalanceMap](../modules/_types_.md#rxbalancemap)> -*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L371)* +*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L371)* **Parameters:** @@ -1077,7 +1077,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)* -*Defined in [Queries.ts:230](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L230)* +*Defined in [Queries.ts:230](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L230)* **Returns:** `Observable`< `u32` | `undefined`> @@ -1088,7 +1088,7 @@ ___ ▸ **votingBalance**(address: * `AccountIndex` | `AccountId` | `string`*): `Observable`<[RxBalance](../modules/_types_.md#rxbalance)> -*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L385)* +*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L385)* **Parameters:** @@ -1105,7 +1105,7 @@ ___ ▸ **votingBalances**(...addresses: *`Array`< `AccountId` | `string`>*): `Observable`<[RxBalance](../modules/_types_.md#rxbalance)[]> -*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L425)* +*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L425)* **Parameters:** @@ -1122,7 +1122,7 @@ ___ ▸ **votingBalancesNominatorsFor**(address: * `AccountId` | `string`*): `Observable`<`any`> -*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L414)* +*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L414)* **Parameters:** diff --git a/docs/api-observable/classes/_index_.api.md b/docs/api-observable/classes/_index_.api.md index 881e3d9576..89fe67c761 100644 --- a/docs/api-observable/classes/_index_.api.md +++ b/docs/api-observable/classes/_index_.api.md @@ -16,7 +16,7 @@ *Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L33)* +*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L33)* **Parameters:** @@ -38,7 +38,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)* -*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L33)* +*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L33)* ___ @@ -49,7 +49,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)* -*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L41)* +*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L41)* ___ @@ -60,7 +60,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)* -*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L42)* +*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L42)* ___ @@ -74,7 +74,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* -*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L87)* +*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L87)* **Returns:** `Hash` @@ -90,7 +90,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[accountIdAndIndex](_combined_.apicombined.md#accountidandindex)* -*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L79)* +*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L79)* **Parameters:** @@ -109,7 +109,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[accountIdFromIndex](_combined_.apicombined.md#accountidfromindex)* -*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L53)* +*Defined in [Combined.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L53)* **Parameters:** @@ -128,7 +128,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[accountIndexFromId](_combined_.apicombined.md#accountindexfromid)* -*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L68)* +*Defined in [Combined.ts:68](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L68)* **Parameters:** @@ -147,7 +147,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[accountIndexes](_combined_.apicombined.md#accountindexes)* -*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L23)* +*Defined in [Combined.ts:23](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L23)* **Returns:** `Observable`<`object`> @@ -160,7 +160,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[accountNonce](_queries_.apiqueries.md#accountnonce)* -*Defined in [Queries.ts:18](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L18)* +*Defined in [Queries.ts:18](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L18)* **Parameters:** @@ -179,7 +179,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceFree](_queries_.apiqueries.md#balancefree)* -*Defined in [Queries.ts:22](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L22)* +*Defined in [Queries.ts:22](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L22)* **Parameters:** @@ -198,7 +198,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[balanceReserved](_queries_.apiqueries.md#balancereserved)* -*Defined in [Queries.ts:26](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L26)* +*Defined in [Queries.ts:26](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L26)* **Parameters:** @@ -217,7 +217,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)* -*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L13)* +*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L13)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -230,7 +230,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumberFinalised](_calls_.apicalls.md#bestnumberfinalised)* -*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L25)* +*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L25)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -243,7 +243,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[blockNow](_queries_.apiqueries.md#blocknow)* -*Defined in [Queries.ts:34](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L34)* +*Defined in [Queries.ts:34](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L34)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -256,7 +256,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[blockPeriod](_queries_.apiqueries.md#blockperiod)* -*Defined in [Queries.ts:30](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L30)* +*Defined in [Queries.ts:30](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L30)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -269,7 +269,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[chain](_calls_.apicalls.md#chain)* -*Defined in [Calls.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L37)* +*Defined in [Calls.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L37)* **Returns:** `Observable`< `Text` | `undefined`> @@ -282,7 +282,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[chainProperties](_calls_.apicalls.md#chainproperties)* -*Defined in [Calls.ts:41](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L41)* +*Defined in [Calls.ts:41](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L41)* **Returns:** `Observable`<`ChainProperties`> @@ -295,7 +295,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)* -*Defined in [Queries.ts:38](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L38)* +*Defined in [Queries.ts:38](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L38)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -308,7 +308,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)* -*Defined in [Queries.ts:42](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L42)* +*Defined in [Queries.ts:42](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L42)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -321,7 +321,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[democracyReferendumVoters](_combined_.apicombined.md#democracyreferendumvoters)* -*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L137)* +*Defined in [Combined.ts:137](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L137)* **Parameters:** @@ -340,7 +340,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersBalancesOf](_combined_.apicombined.md#democracyvotersbalancesof)* -*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L182)* +*Defined in [Combined.ts:182](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L182)* **Parameters:** @@ -359,7 +359,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersVotesOf](_combined_.apicombined.md#democracyvotersvotesof)* -*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L198)* +*Defined in [Combined.ts:198](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L198)* **Parameters:** @@ -378,7 +378,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)* -*Defined in [Queries.ts:125](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L125)* +*Defined in [Queries.ts:125](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L125)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -391,7 +391,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockLength](_combined_.apicombined.md#erablocklength)* -*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L209)* +*Defined in [Combined.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L209)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -404,7 +404,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockProgress](_combined_.apicombined.md#erablockprogress)* -*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L224)* +*Defined in [Combined.ts:224](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L224)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -417,7 +417,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockRemaining](_combined_.apicombined.md#erablockremaining)* -*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L247)* +*Defined in [Combined.ts:247](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L247)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -430,7 +430,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)* -*Defined in [Queries.ts:150](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L150)* +*Defined in [Queries.ts:150](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L150)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -443,7 +443,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)* -*Defined in [Queries.ts:129](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L129)* +*Defined in [Queries.ts:129](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L129)* **Returns:** `Observable`<[RxFees](../modules/_types_.md#rxfees)> @@ -456,7 +456,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[getAccountEnumSet](_queries_.apiqueries.md#getaccountenumset)* -*Defined in [Queries.ts:46](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L46)* +*Defined in [Queries.ts:46](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L46)* **Parameters:** @@ -475,7 +475,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[getBlock](_calls_.apicalls.md#getblock)* -*Defined in [Calls.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L53)* +*Defined in [Calls.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L53)* **Parameters:** @@ -494,7 +494,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)* -*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L91)* +*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L91)* **Returns:** `Observable`<`boolean`> @@ -507,7 +507,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[nextAccountEnumSet](_queries_.apiqueries.md#nextaccountenumset)* -*Defined in [Queries.ts:57](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L57)* +*Defined in [Queries.ts:57](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L57)* **Returns:** `Observable`< `AccountIndex` | `undefined`> @@ -520,7 +520,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[proposalDeposits](_queries_.apiqueries.md#proposaldeposits)* -*Defined in [Queries.ts:61](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L61)* +*Defined in [Queries.ts:61](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L61)* **Parameters:** @@ -539,7 +539,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[publicProposalCount](_combined_.apicombined.md#publicproposalcount)* -*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L115)* +*Defined in [Combined.ts:115](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L115)* **Returns:** `Observable`<`number`> @@ -552,7 +552,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[publicProposals](_queries_.apiqueries.md#publicproposals)* -*Defined in [Queries.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L74)* +*Defined in [Queries.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L74)* **Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> @@ -565,7 +565,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)* -*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L95)* +*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L95)* **Type parameters:** @@ -588,7 +588,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)* -*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L108)* +*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L108)* **Type parameters:** @@ -611,7 +611,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)* -*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L123)* +*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L123)* **Type parameters:** @@ -633,7 +633,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumCount](_queries_.apiqueries.md#referendumcount)* -*Defined in [Queries.ts:93](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L93)* +*Defined in [Queries.ts:93](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L93)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -646,7 +646,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumInfo](_queries_.apiqueries.md#referenduminfo)* -*Defined in [Queries.ts:97](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L97)* +*Defined in [Queries.ts:97](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L97)* **Parameters:** @@ -665,7 +665,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVote](_queries_.apiqueries.md#referendumvote)* -*Defined in [Queries.ts:110](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L110)* +*Defined in [Queries.ts:110](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L110)* **Parameters:** @@ -685,7 +685,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[referendumVoters](_queries_.apiqueries.md#referendumvoters)* -*Defined in [Queries.ts:114](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L114)* +*Defined in [Queries.ts:114](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L114)* **Parameters:** @@ -704,7 +704,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[referendumVotes](_combined_.apicombined.md#referendumvotes)* -*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L174)* +*Defined in [Combined.ts:174](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L174)* **Parameters:** @@ -724,7 +724,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[referendums](_combined_.apicombined.md#referendums)* -*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L153)* +*Defined in [Combined.ts:153](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L153)* **Returns:** `Observable`<`Array`<`ReferendumInfo`>> @@ -737,7 +737,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[referendumsInfo](_combined_.apicombined.md#referendumsinfo)* -*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L125)* +*Defined in [Combined.ts:125](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L125)* **Parameters:** @@ -756,7 +756,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockProgress](_combined_.apicombined.md#sessionblockprogress)* -*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L262)* +*Defined in [Combined.ts:262](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L262)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -769,7 +769,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockRemaining](_combined_.apicombined.md#sessionblockremaining)* -*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L282)* +*Defined in [Combined.ts:282](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L282)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -782,7 +782,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBrokenValue](_combined_.apicombined.md#sessionbrokenvalue)* -*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L297)* +*Defined in [Combined.ts:297](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L297)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -795,7 +795,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)* -*Defined in [Queries.ts:162](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L162)* +*Defined in [Queries.ts:162](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L162)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -808,7 +808,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)* -*Defined in [Queries.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L166)* +*Defined in [Queries.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L166)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -821,7 +821,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)* -*Defined in [Queries.ts:170](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L170)* +*Defined in [Queries.ts:170](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L170)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -834,7 +834,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)* -*Defined in [Queries.ts:174](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L174)* +*Defined in [Queries.ts:174](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L174)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -847,7 +847,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)* -*Defined in [Queries.ts:154](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L154)* +*Defined in [Queries.ts:154](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L154)* **Returns:** `Observable`< `Perbill` | `undefined`> @@ -860,7 +860,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)* -*Defined in [Queries.ts:158](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L158)* +*Defined in [Queries.ts:158](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L158)* **Returns:** `Observable`< `Balance` | `undefined`> @@ -873,7 +873,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeExpected](_combined_.apicombined.md#sessiontimeexpected)* -*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L316)* +*Defined in [Combined.ts:316](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L316)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -886,7 +886,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeRemaining](_combined_.apicombined.md#sessiontimeremaining)* -*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L331)* +*Defined in [Combined.ts:331](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L331)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -899,7 +899,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)* -*Defined in [Queries.ts:182](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L182)* +*Defined in [Queries.ts:182](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L182)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -912,7 +912,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)* -*Defined in [Queries.ts:178](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L178)* +*Defined in [Queries.ts:178](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L178)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -925,7 +925,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)* -*Defined in [Queries.ts:193](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L193)* +*Defined in [Queries.ts:193](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L193)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -938,7 +938,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)* -*Defined in [Queries.ts:215](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L215)* +*Defined in [Queries.ts:215](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L215)* **Parameters:** @@ -957,7 +957,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)* -*Defined in [Queries.ts:204](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L204)* +*Defined in [Queries.ts:204](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L204)* **Parameters:** @@ -976,7 +976,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[submitAndWatchExtrinsic](_calls_.apicalls.md#submitandwatchextrinsic)* -*Defined in [Calls.ts:81](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L81)* +*Defined in [Calls.ts:81](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L81)* **Parameters:** @@ -995,7 +995,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[submitExtrinsic](_calls_.apicalls.md#submitextrinsic)* -*Defined in [Calls.ts:77](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L77)* +*Defined in [Calls.ts:77](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L77)* **Parameters:** @@ -1014,7 +1014,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[subscribeFinalisedHead](_calls_.apicalls.md#subscribefinalisedhead)* -*Defined in [Calls.ts:57](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L57)* +*Defined in [Calls.ts:57](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L57)* **Returns:** `Observable`< `Header` | `undefined`> @@ -1027,7 +1027,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[subscribeNewHead](_calls_.apicalls.md#subscribenewhead)* -*Defined in [Calls.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L63)* +*Defined in [Calls.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L63)* **Returns:** `Observable`< `Header` | `undefined`> @@ -1040,7 +1040,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[systemEvents](_queries_.apiqueries.md#systemevents)* -*Defined in [Queries.ts:219](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L219)* +*Defined in [Queries.ts:219](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L219)* **Returns:** `Observable`<`Array`<`EventRecord`>> @@ -1053,7 +1053,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[systemName](_calls_.apicalls.md#systemname)* -*Defined in [Calls.ts:69](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L69)* +*Defined in [Calls.ts:69](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L69)* **Returns:** `Observable`< `Text` | `undefined`> @@ -1066,7 +1066,7 @@ ___ *Inherited from [ApiCalls](_calls_.apicalls.md).[systemVersion](_calls_.apicalls.md#systemversion)* -*Defined in [Calls.ts:73](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Calls.ts#L73)* +*Defined in [Calls.ts:73](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Calls.ts#L73)* **Returns:** `Observable`< `Text` | `undefined`> @@ -1079,7 +1079,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalance](_combined_.apicombined.md#validatingbalance)* -*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L346)* +*Defined in [Combined.ts:346](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L346)* **Parameters:** @@ -1098,7 +1098,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalances](_combined_.apicombined.md#validatingbalances)* -*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L371)* +*Defined in [Combined.ts:371](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L371)* **Parameters:** @@ -1117,7 +1117,7 @@ ___ *Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)* -*Defined in [Queries.ts:230](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L230)* +*Defined in [Queries.ts:230](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L230)* **Returns:** `Observable`< `u32` | `undefined`> @@ -1130,7 +1130,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalance](_combined_.apicombined.md#votingbalance)* -*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L385)* +*Defined in [Combined.ts:385](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L385)* **Parameters:** @@ -1149,7 +1149,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalances](_combined_.apicombined.md#votingbalances)* -*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L425)* +*Defined in [Combined.ts:425](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L425)* **Parameters:** @@ -1168,7 +1168,7 @@ ___ *Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalancesNominatorsFor](_combined_.apicombined.md#votingbalancesnominatorsfor)* -*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Combined.ts#L414)* +*Defined in [Combined.ts:414](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Combined.ts#L414)* **Parameters:** diff --git a/docs/api-observable/classes/_queries_.apiqueries.md b/docs/api-observable/classes/_queries_.apiqueries.md index f420d1aa2a..92863e722d 100644 --- a/docs/api-observable/classes/_queries_.apiqueries.md +++ b/docs/api-observable/classes/_queries_.apiqueries.md @@ -18,7 +18,7 @@ *Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L33)* +*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L33)* **Parameters:** @@ -40,7 +40,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[whenReady](_base_.apibase.md#whenready)* -*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L33)* +*Defined in [Base.ts:33](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L33)* ___ @@ -51,7 +51,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[extrinsics](_base_.apibase.md#extrinsics)* -*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L41)* +*Defined in [Base.ts:41](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L41)* ___ @@ -62,7 +62,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[storage](_base_.apibase.md#storage)* -*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L42)* +*Defined in [Base.ts:42](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L42)* ___ @@ -76,7 +76,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* -*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L87)* +*Defined in [Base.ts:87](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L87)* **Returns:** `Hash` @@ -90,7 +90,7 @@ ___ ▸ **accountNonce**(address: * `AccountId` | `string`*): `Observable`< `Index` | `undefined`> -*Defined in [Queries.ts:18](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L18)* +*Defined in [Queries.ts:18](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L18)* **Parameters:** @@ -107,7 +107,7 @@ ___ ▸ **balanceFree**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`> -*Defined in [Queries.ts:22](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L22)* +*Defined in [Queries.ts:22](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L22)* **Parameters:** @@ -124,7 +124,7 @@ ___ ▸ **balanceReserved**(address: * `AccountId` | `string`*): `Observable`< `Balance` | `undefined`> -*Defined in [Queries.ts:26](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L26)* +*Defined in [Queries.ts:26](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L26)* **Parameters:** @@ -141,7 +141,7 @@ ___ ▸ **blockNow**(): `Observable`< `Moment` | `undefined`> -*Defined in [Queries.ts:34](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L34)* +*Defined in [Queries.ts:34](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L34)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -152,7 +152,7 @@ ___ ▸ **blockPeriod**(): `Observable`< `Moment` | `undefined`> -*Defined in [Queries.ts:30](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L30)* +*Defined in [Queries.ts:30](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L30)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -163,7 +163,7 @@ ___ ▸ **democracyLaunchPeriod**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:38](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L38)* +*Defined in [Queries.ts:38](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L38)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -174,7 +174,7 @@ ___ ▸ **democracyNextTally**(): `Observable`< `ReferendumIndex` | `undefined`> -*Defined in [Queries.ts:42](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L42)* +*Defined in [Queries.ts:42](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L42)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -185,7 +185,7 @@ ___ ▸ **democracyVotingPeriod**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:125](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L125)* +*Defined in [Queries.ts:125](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L125)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -196,7 +196,7 @@ ___ ▸ **eraLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:150](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L150)* +*Defined in [Queries.ts:150](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L150)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -207,7 +207,7 @@ ___ ▸ **fees**(): `Observable`<[RxFees](../modules/_types_.md#rxfees)> -*Defined in [Queries.ts:129](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L129)* +*Defined in [Queries.ts:129](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L129)* **Returns:** `Observable`<[RxFees](../modules/_types_.md#rxfees)> @@ -218,7 +218,7 @@ ___ ▸ **getAccountEnumSet**(index: * `AccountIndex` | `BN` | `number`*): `Observable`< `Array`<`AccountId`> | `undefined`> -*Defined in [Queries.ts:46](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L46)* +*Defined in [Queries.ts:46](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L46)* **Parameters:** @@ -237,7 +237,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)* -*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L91)* +*Defined in [Base.ts:91](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L91)* **Returns:** `Observable`<`boolean`> @@ -248,7 +248,7 @@ ___ ▸ **nextAccountEnumSet**(): `Observable`< `AccountIndex` | `undefined`> -*Defined in [Queries.ts:57](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L57)* +*Defined in [Queries.ts:57](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L57)* **Returns:** `Observable`< `AccountIndex` | `undefined`> @@ -259,7 +259,7 @@ ___ ▸ **proposalDeposits**(proposalId: * `PropIndex` | `BN` | `number`*): `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) | `undefined`> -*Defined in [Queries.ts:61](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L61)* +*Defined in [Queries.ts:61](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L61)* **Parameters:** @@ -276,7 +276,7 @@ ___ ▸ **publicProposals**(): `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> -*Defined in [Queries.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L74)* +*Defined in [Queries.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L74)* **Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>> @@ -289,7 +289,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)* -*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L95)* +*Defined in [Base.ts:95](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L95)* **Type parameters:** @@ -312,7 +312,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)* -*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L108)* +*Defined in [Base.ts:108](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L108)* **Type parameters:** @@ -335,7 +335,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)* -*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Base.ts#L123)* +*Defined in [Base.ts:123](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Base.ts#L123)* **Type parameters:** @@ -355,7 +355,7 @@ ___ ▸ **referendumCount**(): `Observable`< `ReferendumIndex` | `undefined`> -*Defined in [Queries.ts:93](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L93)* +*Defined in [Queries.ts:93](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L93)* **Returns:** `Observable`< `ReferendumIndex` | `undefined`> @@ -366,7 +366,7 @@ ___ ▸ **referendumInfo**(referendumId: * `ReferendumIndex` | `BN` | `number`*): `Observable`< `ReferendumInfo` | `undefined`> -*Defined in [Queries.ts:97](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L97)* +*Defined in [Queries.ts:97](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L97)* **Parameters:** @@ -383,7 +383,7 @@ ___ ▸ **referendumVote**(index: * `ReferendumIndex` | `BN` | `number`*, address: * `AccountId` | `string`*): `Observable`< `Bool` | `undefined`> -*Defined in [Queries.ts:110](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L110)* +*Defined in [Queries.ts:110](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L110)* **Parameters:** @@ -401,7 +401,7 @@ ___ ▸ **referendumVoters**(index: * `ReferendumIndex` | `BN` | `number`*): `Observable`<`Array`<`AccountId`>> -*Defined in [Queries.ts:114](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L114)* +*Defined in [Queries.ts:114](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L114)* **Parameters:** @@ -418,7 +418,7 @@ ___ ▸ **sessionCurrentIndex**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:162](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L162)* +*Defined in [Queries.ts:162](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L162)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -429,7 +429,7 @@ ___ ▸ **sessionCurrentStart**(): `Observable`< `Moment` | `undefined`> -*Defined in [Queries.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L166)* +*Defined in [Queries.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L166)* **Returns:** `Observable`< `Moment` | `undefined`> @@ -440,7 +440,7 @@ ___ ▸ **sessionLastLengthChange**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:170](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L170)* +*Defined in [Queries.ts:170](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L170)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -451,7 +451,7 @@ ___ ▸ **sessionLength**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:174](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L174)* +*Defined in [Queries.ts:174](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L174)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -462,7 +462,7 @@ ___ ▸ **sessionReward**(): `Observable`< `Perbill` | `undefined`> -*Defined in [Queries.ts:154](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L154)* +*Defined in [Queries.ts:154](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L154)* **Returns:** `Observable`< `Perbill` | `undefined`> @@ -473,7 +473,7 @@ ___ ▸ **sessionRewardCurrent**(): `Observable`< `Balance` | `undefined`> -*Defined in [Queries.ts:158](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L158)* +*Defined in [Queries.ts:158](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L158)* **Returns:** `Observable`< `Balance` | `undefined`> @@ -484,7 +484,7 @@ ___ ▸ **sessionValidators**(): `Observable`<`Array`<`AccountId`>> -*Defined in [Queries.ts:182](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L182)* +*Defined in [Queries.ts:182](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L182)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -495,7 +495,7 @@ ___ ▸ **sessionsPerEra**(): `Observable`< `BlockNumber` | `undefined`> -*Defined in [Queries.ts:178](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L178)* +*Defined in [Queries.ts:178](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L178)* **Returns:** `Observable`< `BlockNumber` | `undefined`> @@ -506,7 +506,7 @@ ___ ▸ **stakingIntentions**(): `Observable`<`Array`<`AccountId`>> -*Defined in [Queries.ts:193](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L193)* +*Defined in [Queries.ts:193](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L193)* **Returns:** `Observable`<`Array`<`AccountId`>> @@ -517,7 +517,7 @@ ___ ▸ **stakingNominating**(address: * `AccountId` | `string`*): `Observable`< `AccountId` | `undefined`> -*Defined in [Queries.ts:215](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L215)* +*Defined in [Queries.ts:215](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L215)* **Parameters:** @@ -534,7 +534,7 @@ ___ ▸ **stakingNominatorsFor**(address: * `AccountId` | `string`*): `Observable`<`Array`<`AccountId`>> -*Defined in [Queries.ts:204](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L204)* +*Defined in [Queries.ts:204](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L204)* **Parameters:** @@ -551,7 +551,7 @@ ___ ▸ **systemEvents**(): `Observable`<`Array`<`EventRecord`>> -*Defined in [Queries.ts:219](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L219)* +*Defined in [Queries.ts:219](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L219)* **Returns:** `Observable`<`Array`<`EventRecord`>> @@ -562,7 +562,7 @@ ___ ▸ **validatorCount**(): `Observable`< `u32` | `undefined`> -*Defined in [Queries.ts:230](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/Queries.ts#L230)* +*Defined in [Queries.ts:230](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/Queries.ts#L230)* **Returns:** `Observable`< `u32` | `undefined`> diff --git a/docs/api-observable/modules/_types_.md b/docs/api-observable/modules/_types_.md index ba0a18014c..efb4cf877e 100644 --- a/docs/api-observable/modules/_types_.md +++ b/docs/api-observable/modules/_types_.md @@ -9,7 +9,7 @@ **Ƭ ApiFunctions**: * `keyof ApiBase` | `keyof ApiCalls` | `keyof ApiCombined` | `keyof ApiQueries` * -*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/types.ts#L12)* +*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/types.ts#L12)* ___ @@ -18,7 +18,7 @@ ___ **Ƭ RxBalance**: *`object`* -*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/types.ts#L14)* #### Type declaration @@ -29,7 +29,7 @@ ___ **Ƭ RxBalanceMap**: *`object`* -*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/types.ts#L38)* +*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/types.ts#L38)* #### Type declaration @@ -42,7 +42,7 @@ ___ **Ƭ RxFees**: *`object`* -*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/types.ts#L24)* #### Type declaration @@ -53,7 +53,7 @@ ___ **Ƭ RxReferendumVote**: *`object`* -*Defined in [types.ts:32](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api-observable/src/types.ts#L32)* +*Defined in [types.ts:32](https://github.com/polkadot-js/api/blob/e802b8e/packages/api-observable/src/types.ts#L32)* #### Type declaration diff --git a/docs/api/classes/_base_.apibase.md b/docs/api/classes/_base_.apibase.md index 63517cf0dd..6826c003c3 100644 --- a/docs/api/classes/_base_.apibase.md +++ b/docs/api/classes/_base_.apibase.md @@ -24,7 +24,7 @@ ⊕ **new ApiBase**(provider?: * [ApiOptions](../interfaces/_types_.apioptions.md) | `ProviderInterface`*): [ApiBase](_base_.apibase.md) -*Defined in [Base.ts:38](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/Base.ts#L38)* +*Defined in [Base.ts:38](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/Base.ts#L38)* *__description__*: Create an instance of the class @@ -58,7 +58,7 @@ ___ getgenesisHash(): `Hash` -*Defined in [Base.ts:77](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/Base.ts#L77)* +*Defined in [Base.ts:77](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/Base.ts#L77)* *__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions. @@ -71,7 +71,7 @@ ___ gethasSubscriptions(): `boolean` -*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/Base.ts#L86)* +*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/Base.ts#L86)* *__description__*: `true` when subscriptions are supported @@ -84,7 +84,7 @@ ___ getquery(): `S` -*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/Base.ts#L122)* +*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/Base.ts#L122)* *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. @@ -107,7 +107,7 @@ ___ getrpc(): `R` -*Defined in [Base.ts:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/Base.ts#L142)* +*Defined in [Base.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/Base.ts#L142)* *__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime. @@ -130,7 +130,7 @@ ___ getruntimeMetadata(): `Metadata` -*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/Base.ts#L93)* +*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/Base.ts#L93)* *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. @@ -143,7 +143,7 @@ ___ getruntimeVersion(): `RuntimeVersion` -*Defined in [Base.ts:102](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/Base.ts#L102)* +*Defined in [Base.ts:102](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/Base.ts#L102)* *__description__*: Contains the version information for the current runtime. @@ -156,7 +156,7 @@ ___ gettx(): `E` -*Defined in [Base.ts:161](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/Base.ts#L161)* +*Defined in [Base.ts:161](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/Base.ts#L161)* *__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata. @@ -183,7 +183,7 @@ ___ ▸ **on**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` -*Defined in [Base.ts:186](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/Base.ts#L186)* +*Defined in [Base.ts:186](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/Base.ts#L186)* *__description__*: Attach an eventemitter handler to listen to a specific event @@ -215,7 +215,7 @@ ___ ▸ **once**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` -*Defined in [Base.ts:210](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/Base.ts#L210)* +*Defined in [Base.ts:210](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/Base.ts#L210)* *__description__*: Attach an one-time eventemitter handler to listen to a specific event diff --git a/docs/api/classes/_promise_combinator_.combinator.md b/docs/api/classes/_promise_combinator_.combinator.md index c7d18fa31f..9737a40ff5 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) | [`Array`<`any`>, [CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction)]>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [Combinator](_promise_combinator_.combinator.md) -*Defined in [promise/Combinator.ts:23](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/promise/Combinator.ts#L23)* +*Defined in [promise/Combinator.ts:23](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/promise/Combinator.ts#L23)* **Parameters:** @@ -33,7 +33,7 @@ ___ getid(): `number` -*Defined in [promise/Combinator.ts:54](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/promise/Combinator.ts#L54)* +*Defined in [promise/Combinator.ts:54](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/promise/Combinator.ts#L54)* **Returns:** `number` @@ -47,7 +47,7 @@ ___ ▸ **unsubscribe**(): `Promise`<`any`> -*Defined in [promise/Combinator.ts:87](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/promise/Combinator.ts#L87)* +*Defined in [promise/Combinator.ts:87](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/promise/Combinator.ts#L87)* **Returns:** `Promise`<`any`> @@ -58,7 +58,7 @@ ___ ▸ **lookup**(id: *`number`*): [Combinator](_promise_combinator_.combinator.md) -*Defined in [promise/Combinator.ts:42](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/promise/Combinator.ts#L42)* +*Defined in [promise/Combinator.ts:42](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/promise/Combinator.ts#L42)* **Parameters:** @@ -75,7 +75,7 @@ ___ ▸ **unsubscribe**(id: *`number`*): `Promise`<`any`> -*Defined in [promise/Combinator.ts:46](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/promise/Combinator.ts#L46)* +*Defined in [promise/Combinator.ts:46](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/promise/Combinator.ts#L46)* **Parameters:** diff --git a/docs/api/classes/_promise_index_.apipromise.html b/docs/api/classes/_promise_index_.apipromise.html index 2ae61279ad..b5f0b13594 100644 --- a/docs/api/classes/_promise_index_.apipromise.html +++ b/docs/api/classes/_promise_index_.apipromise.html @@ -2036,7 +2036,7 @@

constructor

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

Overrides ApiBase.constructor

-

Defined in promise/index.ts:133

+

Defined in promise/index.ts:133

description: Creates an instance of the ApiPromise class

example:

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

genesisHash

getgenesisHash(): Hash

Inherited from ApiBase.genesisHash

-

Defined in Base.ts:77

+

Defined in Base.ts:77

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

Returns: Hash


@@ -2079,14 +2079,14 @@

hasSubscriptions

gethasSubscriptions(): boolean

Inherited from ApiBase.hasSubscriptions

-

Defined in Base.ts:86

+

Defined in Base.ts:86

description: true when subscriptions are supported

Returns: boolean


isReady

getisReady(): Promise<ApiPromise>

-

Defined in promise/index.ts:172

+

Defined in promise/index.ts:172

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

Returns: Promise<ApiPromise>


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

query

getquery(): QueryableStorage

Inherited from ApiBase.query

-

Defined in Base.ts:122

+

Defined in Base.ts:122

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

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

example:

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

rpc

getrpc(): Rpc

Inherited from ApiBase.rpc

-

Defined in Base.ts:142

+

Defined in Base.ts:142

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

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

example:

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

runtimeMetadata

getruntimeMetadata(): Metadata

Inherited from ApiBase.runtimeMetadata

-

Defined in Base.ts:93

+

Defined in Base.ts:93

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

Returns: Metadata


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

runtimeVersion

getruntimeVersion(): RuntimeVersion

Inherited from ApiBase.runtimeVersion

-

Defined in Base.ts:102

+

Defined in Base.ts:102

description: Contains the version information for the current runtime.

Returns: RuntimeVersion


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

tx

gettx(): SubmittableExtrinsics

Inherited from ApiBase.tx

-

Defined in Base.ts:161

+

Defined in Base.ts:161

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

example:

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

combineLatest

▸ combineLatest(fns: Array<CombinatorFunction>, callback: CombinatorCallback): Combinator

-

Defined in promise/index.ts:200

+

Defined in promise/index.ts:200

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

example:

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

on

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

Inherited from ApiBase.on

-

Defined in Base.ts:186

+

Defined in Base.ts:186

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

example:

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

once

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

Inherited from ApiBase.once

-

Defined in Base.ts:210

+

Defined in Base.ts:210

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

example:

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

<Static> create

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

-

Defined in promise/index.ts:131

+

Defined in promise/index.ts:131

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

example:

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

constructor

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

Overrides ApiBase.constructor

-

Defined in rx/index.ts:143

+

Defined in rx/index.ts:143

description: Create an instance of the ApiRx class

example:

import Api from '@polkadot/api/rx';
@@ -2082,7 +2082,7 @@
 

genesisHash

getgenesisHash(): Hash

Inherited from ApiBase.genesisHash

-

Defined in Base.ts:77

+

Defined in Base.ts:77

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

Returns: Hash


@@ -2090,21 +2090,21 @@

hasSubscriptions

gethasSubscriptions(): boolean

Inherited from ApiBase.hasSubscriptions

-

Defined in Base.ts:86

+

Defined in Base.ts:86

description: true when subscriptions are supported

Returns: boolean


isConnected

getisConnected(): Observable<boolean>

-

Defined in rx/index.ts:181

+

Defined in rx/index.ts:181

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

+

Defined in rx/index.ts:188

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

Returns: Observable<ApiRx>


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

query

getquery(): QueryableStorage

Inherited from ApiBase.query

-

Defined in Base.ts:122

+

Defined in Base.ts:122

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

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

example:

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

rpc

getrpc(): RpcRx

Inherited from ApiBase.rpc

-

Defined in Base.ts:142

+

Defined in Base.ts:142

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

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

example:

@@ -2140,7 +2140,7 @@

runtimeMetadata

getruntimeMetadata(): Metadata

Inherited from ApiBase.runtimeMetadata

-

Defined in Base.ts:93

+

Defined in Base.ts:93

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

Returns: Metadata


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

runtimeVersion

getruntimeVersion(): RuntimeVersion

Inherited from ApiBase.runtimeVersion

-

Defined in Base.ts:102

+

Defined in Base.ts:102

description: Contains the version information for the current runtime.

Returns: RuntimeVersion


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

tx

gettx(): SubmittableExtrinsics

Inherited from ApiBase.tx

-

Defined in Base.ts:161

+

Defined in Base.ts:161

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

example:

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

on

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

Inherited from ApiBase.on

-

Defined in Base.ts:186

+

Defined in Base.ts:186

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

example:

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

once

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

Inherited from ApiBase.once

-

Defined in Base.ts:210

+

Defined in Base.ts:210

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

example:

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

<Static> create

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

-

Defined in rx/index.ts:141

+

Defined in rx/index.ts:141

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

example:

import Api from '@polkadot/api/rx';
@@ -2323,7 +2323,7 @@
     
 
diff --git a/docs/api/classes/_rx_index_.apirx.md b/docs/api/classes/_rx_index_.apirx.md index 623ef520ab..146c8f105c 100644 --- a/docs/api/classes/_rx_index_.apirx.md +++ b/docs/api/classes/_rx_index_.apirx.md @@ -117,7 +117,7 @@ api.query.system *Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* -*Defined in [rx/index.ts:143](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/rx/index.ts#L143)* +*Defined in [rx/index.ts:143](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/rx/index.ts#L143)* *__description__*: Create an instance of the ApiRx class @@ -153,7 +153,7 @@ getgenesisHash(): `Hash` *Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* -*Defined in [Base.ts:77](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/Base.ts#L77)* +*Defined in [Base.ts:77](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/Base.ts#L77)* *__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions. @@ -168,7 +168,7 @@ gethasSubscriptions(): `boolean` *Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)* -*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/Base.ts#L86)* +*Defined in [Base.ts:86](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/Base.ts#L86)* *__description__*: `true` when subscriptions are supported @@ -181,7 +181,7 @@ ___ getisConnected(): `Observable`<`boolean`> -*Defined in [rx/index.ts:181](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/rx/index.ts#L181)* +*Defined in [rx/index.ts:181](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/rx/index.ts#L181)* *__description__*: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity. @@ -194,7 +194,7 @@ ___ getisReady(): `Observable`<[ApiRx](_rx_index_.apirx.md)> -*Defined in [rx/index.ts:188](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/rx/index.ts#L188)* +*Defined in [rx/index.ts:188](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/rx/index.ts#L188)* *__description__*: Observable that returns the first time we are connected and loaded @@ -209,7 +209,7 @@ getquery(): [QueryableStorage](../interfaces/_rx_types_.queryablestorage.md) *Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)* -*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/Base.ts#L122)* +*Defined in [Base.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/Base.ts#L122)* *__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. @@ -234,7 +234,7 @@ getrpc(): `RpcRx` *Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)* -*Defined in [Base.ts:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/Base.ts#L142)* +*Defined in [Base.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/Base.ts#L142)* *__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime. @@ -259,7 +259,7 @@ getruntimeMetadata(): `Metadata` *Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)* -*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/Base.ts#L93)* +*Defined in [Base.ts:93](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/Base.ts#L93)* *__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. @@ -274,7 +274,7 @@ getruntimeVersion(): `RuntimeVersion` *Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)* -*Defined in [Base.ts:102](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/Base.ts#L102)* +*Defined in [Base.ts:102](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/Base.ts#L102)* *__description__*: Contains the version information for the current runtime. @@ -289,7 +289,7 @@ gettx(): [SubmittableExtrinsics](../interfaces/_rx_types_.submittableextrinsics. *Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)* -*Defined in [Base.ts:161](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/Base.ts#L161)* +*Defined in [Base.ts:161](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/Base.ts#L161)* *__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata. @@ -318,7 +318,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)* -*Defined in [Base.ts:186](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/Base.ts#L186)* +*Defined in [Base.ts:186](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/Base.ts#L186)* *__description__*: Attach an eventemitter handler to listen to a specific event @@ -352,7 +352,7 @@ ___ *Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)* -*Defined in [Base.ts:210](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/Base.ts#L210)* +*Defined in [Base.ts:210](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/Base.ts#L210)* *__description__*: Attach an one-time eventemitter handler to listen to a specific event @@ -384,7 +384,7 @@ ___ ▸ **create**(options?: * [ApiOptions](../interfaces/_types_.apioptions.md) | `ProviderInterface`*): `Observable`<[ApiRx](_rx_index_.apirx.md)> -*Defined in [rx/index.ts:141](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/rx/index.ts#L141)* +*Defined in [rx/index.ts:141](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/rx/index.ts#L141)* *__description__*: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance. diff --git a/docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md b/docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md index f746b68051..3fbf432a2e 100644 --- a/docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md +++ b/docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md @@ -25,7 +25,7 @@ *Overrides Extrinsic.__constructor* -*Defined in [rx/SubmittableExtrinsic.ts:17](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/rx/SubmittableExtrinsic.ts#L17)* +*Defined in [rx/SubmittableExtrinsic.ts:17](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/rx/SubmittableExtrinsic.ts#L17)* **Parameters:** @@ -73,7 +73,7 @@ getType(): `E` *Inherited from Struct.Type* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -88,7 +88,7 @@ getargs(): `Array`<`Codec`> *Inherited from Extrinsic.args* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:71](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L71)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:71](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L71)* *__description__*: The arguments passed to for the call, exposes args so it is compatible with \[\[Method\]\] @@ -103,7 +103,7 @@ getcallIndex(): `Uint8Array` *Inherited from Extrinsic.callIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:78](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L78)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:78](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L78)* *__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method @@ -118,7 +118,7 @@ getdata(): `Uint8Array` *Inherited from Extrinsic.data* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L85)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L85)* *__description__*: The actual data for the Method @@ -135,7 +135,7 @@ getencodedLength(): `number` *Overrides Struct.encodedLength* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L92)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L92)* *__description__*: The length of the value when encoded as a Uint8Array @@ -150,7 +150,7 @@ gethash(): `Hash` *Inherited from Extrinsic.hash* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L101)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L101)* *__description__*: Convernience function, encodes the extrinsic and returns the actual hash @@ -165,7 +165,7 @@ getisSigned(): `boolean` *Inherited from Extrinsic.isSigned* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L110)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L110)* *__description__*: `true` id the extrinsic is signed @@ -180,7 +180,7 @@ getlength(): `number` *Inherited from Extrinsic.length* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:117](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L117)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:117](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L117)* *__description__*: The length of the encoded value @@ -195,7 +195,7 @@ getmeta(): `FunctionMetadata` *Inherited from Extrinsic.meta* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:124](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L124)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:124](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L124)* *__description__*: The \[\[FunctionMetadata\]\] that describes the extrinsic @@ -210,7 +210,7 @@ getmethod(): `Method` *Inherited from Extrinsic.method* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L131)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L131)* *__description__*: The \[\[Method\]\] this extrinsic wraps @@ -225,7 +225,7 @@ getsignature(): `ExtrinsicSignature` *Inherited from Extrinsic.signature* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:138](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L138)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:138](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L138)* *__description__*: The \[\[ExtrinsicSignature\]\] @@ -258,7 +258,7 @@ ___ *Inherited from Extrinsic.addSignature* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:145](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L145)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:145](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L145)* *__description__*: Add an \[\[ExtrinsicSignature\]\] to the extrinsic (already generated) @@ -351,7 +351,7 @@ ___ *Overrides Map.get* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -372,7 +372,7 @@ ___ *Inherited from Struct.getAtIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -425,7 +425,7 @@ ___ ▸ **send**(): `Observable`<[SubmittableSendResult](../modules/_types_.md#submittablesendresult)> -*Defined in [rx/SubmittableExtrinsic.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/rx/SubmittableExtrinsic.ts#L48)* +*Defined in [rx/SubmittableExtrinsic.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/rx/SubmittableExtrinsic.ts#L48)* **Returns:** `Observable`<[SubmittableSendResult](../modules/_types_.md#submittablesendresult)> @@ -458,7 +458,7 @@ ___ *Overrides Extrinsic.sign* -*Defined in [rx/SubmittableExtrinsic.ts:54](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/rx/SubmittableExtrinsic.ts#L54)* +*Defined in [rx/SubmittableExtrinsic.ts:54](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/rx/SubmittableExtrinsic.ts#L54)* **Parameters:** @@ -479,7 +479,7 @@ ___ *Inherited from Struct.toArray* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -496,7 +496,7 @@ ___ *Overrides Struct.toHex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:163](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L163)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:163](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L163)* *__description__*: Returns a hex string representation of the value @@ -513,7 +513,7 @@ ___ *Overrides Struct.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:170](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L170)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:170](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L170)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -528,7 +528,7 @@ ___ *Inherited from Struct.toString* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -545,7 +545,7 @@ ___ *Overrides Struct.toU8a* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:178](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L178)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:178](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L178)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -581,7 +581,7 @@ ___ *Inherited from Extrinsic.decodeExtrinsic* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L44)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L44)* **Parameters:** @@ -600,7 +600,7 @@ ___ *Inherited from Struct.with* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/api/index.html b/docs/api/index.html index 4f713ec737..4e6d23f3b3 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -2062,7 +2062,7 @@
diff --git a/docs/api/interfaces/_promise_types_.apipromiseinterface.md b/docs/api/interfaces/_promise_types_.apipromiseinterface.md index b650252891..8686bf7c58 100644 --- a/docs/api/interfaces/_promise_types_.apipromiseinterface.md +++ b/docs/api/interfaces/_promise_types_.apipromiseinterface.md @@ -20,7 +20,7 @@ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[genesisHash](_types_.apibaseinterface.md#genesishash)* -*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L13)* ___ @@ -31,7 +31,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[hasSubscriptions](_types_.apibaseinterface.md#hassubscriptions)* -*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L14)* ___ @@ -40,7 +40,7 @@ ___ **● isReady**: *`Promise`<[ApiPromiseInterface](_promise_types_.apipromiseinterface.md)>* -*Defined in [promise/types.ts:44](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/promise/types.ts#L44)* +*Defined in [promise/types.ts:44](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/promise/types.ts#L44)* ___ @@ -51,7 +51,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[on](_types_.apibaseinterface.md#on)* -*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L21)* #### Type declaration ▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void` @@ -74,7 +74,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[query](_types_.apibaseinterface.md#query)* -*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L17)* ___ @@ -85,7 +85,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[rpc](_types_.apibaseinterface.md#rpc)* -*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L18)* ___ @@ -96,7 +96,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeMetadata](_types_.apibaseinterface.md#runtimemetadata)* -*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L15)* ___ @@ -107,7 +107,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeVersion](_types_.apibaseinterface.md#runtimeversion)* -*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L16)* ___ @@ -118,7 +118,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[tx](_types_.apibaseinterface.md#tx)* -*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L19)* ___ diff --git a/docs/api/interfaces/_promise_types_.queryablestoragefunction.md b/docs/api/interfaces/_promise_types_.queryablestoragefunction.md index 61294fb93c..5a955dd641 100644 --- a/docs/api/interfaces/_promise_types_.queryablestoragefunction.md +++ b/docs/api/interfaces/_promise_types_.queryablestoragefunction.md @@ -15,7 +15,7 @@ ▸ **__call**(arg?: *`any`*): `Uint8Array` -*Defined in [promise/types.ts:15](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/promise/types.ts#L15)* +*Defined in [promise/types.ts:15](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/promise/types.ts#L15)* **Parameters:** @@ -25,7 +25,7 @@ **Returns:** `Promise`< `Codec` | `null` | `undefined`> -*Defined in [promise/types.ts:16](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/promise/types.ts#L16)* +*Defined in [promise/types.ts:16](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/promise/types.ts#L16)* **Parameters:** @@ -35,7 +35,7 @@ **Returns:** `Promise`<`number`> -*Defined in [promise/types.ts:17](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/promise/types.ts#L17)* +*Defined in [promise/types.ts:17](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/promise/types.ts#L17)* **Parameters:** @@ -46,7 +46,7 @@ **Returns:** `Promise`<`number`> -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StorageKey.ts#L12)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StorageKey.ts#L12)* **Parameters:** @@ -64,7 +64,7 @@ **● at**: *`function`* -*Defined in [promise/types.ts:19](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/promise/types.ts#L19)* +*Defined in [promise/types.ts:19](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/promise/types.ts#L19)* #### Type declaration ▸(hash: *`Hash`*, arg?: *`any`*): `Promise`< `Codec` | `null` | `undefined`> @@ -87,7 +87,7 @@ ___ *Inherited from StorageFunction.meta* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StorageKey.ts#L14)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StorageKey.ts#L14)* ___ @@ -98,7 +98,7 @@ ___ *Inherited from StorageFunction.method* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StorageKey.ts#L15)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StorageKey.ts#L15)* ___ @@ -109,7 +109,7 @@ ___ *Inherited from StorageFunction.section* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StorageKey.ts#L16)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StorageKey.ts#L16)* ___ @@ -120,7 +120,7 @@ ___ *Inherited from StorageFunction.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StorageKey.ts#L17)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StorageKey.ts#L17)* #### Type declaration ▸(): `any` @@ -134,7 +134,7 @@ ___ **● unsubscribe**: *`function`* -*Defined in [promise/types.ts:20](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/promise/types.ts#L20)* +*Defined in [promise/types.ts:20](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/promise/types.ts#L20)* #### Type declaration ▸(subscriptionId: *`number`*): `Promise`<`any`> diff --git a/docs/api/interfaces/_promise_types_.submittableextrinsicfunction.md b/docs/api/interfaces/_promise_types_.submittableextrinsicfunction.md index 74f518e1a3..737a341a38 100644 --- a/docs/api/interfaces/_promise_types_.submittableextrinsicfunction.md +++ b/docs/api/interfaces/_promise_types_.submittableextrinsicfunction.md @@ -11,7 +11,7 @@ ▸ **__call**(...args: *`any`[]*): `Method` -*Defined in [promise/types.ts:31](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/promise/types.ts#L31)* +*Defined in [promise/types.ts:31](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/promise/types.ts#L31)* **Parameters:** @@ -21,7 +21,7 @@ **Returns:** [SubmittableExtrinsic](../classes/_promise_submittableextrinsic_.submittableextrinsic.md) -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:28](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L28)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:28](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L28)* **Parameters:** @@ -41,7 +41,7 @@ *Inherited from MethodFunction.callIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:30](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L30)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:30](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L30)* ___ @@ -52,7 +52,7 @@ ___ *Inherited from MethodFunction.meta* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:31](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L31)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:31](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L31)* ___ @@ -63,7 +63,7 @@ ___ *Inherited from MethodFunction.method* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:32](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L32)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:32](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L32)* ___ @@ -74,7 +74,7 @@ ___ *Inherited from MethodFunction.section* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:33](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L33)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:33](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L33)* ___ @@ -85,7 +85,7 @@ ___ *Inherited from MethodFunction.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L34)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L34)* #### Type declaration ▸(): `any` diff --git a/docs/api/interfaces/_rx_types_.apirxinterface.md b/docs/api/interfaces/_rx_types_.apirxinterface.md index f9d8b48243..4e5a46ff01 100644 --- a/docs/api/interfaces/_rx_types_.apirxinterface.md +++ b/docs/api/interfaces/_rx_types_.apirxinterface.md @@ -20,7 +20,7 @@ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[genesisHash](_types_.apibaseinterface.md#genesishash)* -*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L13)* ___ @@ -31,7 +31,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[hasSubscriptions](_types_.apibaseinterface.md#hassubscriptions)* -*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L14)* ___ @@ -40,7 +40,7 @@ ___ **● isConnected**: *`Observable`<`boolean`>* -*Defined in [rx/types.ts:42](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/rx/types.ts#L42)* +*Defined in [rx/types.ts:42](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/rx/types.ts#L42)* ___ @@ -49,7 +49,7 @@ ___ **● isReady**: *`Observable`<[ApiRxInterface](_rx_types_.apirxinterface.md)>* -*Defined in [rx/types.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/rx/types.ts#L43)* +*Defined in [rx/types.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/rx/types.ts#L43)* ___ @@ -60,7 +60,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[on](_types_.apibaseinterface.md#on)* -*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L21)* #### Type declaration ▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void` @@ -83,7 +83,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[query](_types_.apibaseinterface.md#query)* -*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L17)* ___ @@ -94,7 +94,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[rpc](_types_.apibaseinterface.md#rpc)* -*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L18)* ___ @@ -105,7 +105,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeMetadata](_types_.apibaseinterface.md#runtimemetadata)* -*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L15)* ___ @@ -116,7 +116,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[runtimeVersion](_types_.apibaseinterface.md#runtimeversion)* -*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L16)* ___ @@ -127,7 +127,7 @@ ___ *Inherited from [ApiBaseInterface](_types_.apibaseinterface.md).[tx](_types_.apibaseinterface.md#tx)* -*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L19)* ___ diff --git a/docs/api/interfaces/_rx_types_.queryablestoragefunction.md b/docs/api/interfaces/_rx_types_.queryablestoragefunction.md index 94d672f7c4..35ed76843d 100644 --- a/docs/api/interfaces/_rx_types_.queryablestoragefunction.md +++ b/docs/api/interfaces/_rx_types_.queryablestoragefunction.md @@ -11,7 +11,7 @@ ▸ **__call**(arg?: *`any`*): `Uint8Array` -*Defined in [rx/types.ts:16](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/rx/types.ts#L16)* +*Defined in [rx/types.ts:16](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/rx/types.ts#L16)* **Parameters:** @@ -21,7 +21,7 @@ **Returns:** `Observable`< `Codec` | `null` | `undefined`> -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StorageKey.ts#L12)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StorageKey.ts#L12)* **Parameters:** @@ -39,7 +39,7 @@ **● at**: *`function`* -*Defined in [rx/types.ts:18](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/rx/types.ts#L18)* +*Defined in [rx/types.ts:18](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/rx/types.ts#L18)* #### Type declaration ▸(hash: *`Hash`*, arg?: *`any`*): `Observable`< `Codec` | `null` | `undefined`> @@ -62,7 +62,7 @@ ___ *Inherited from StorageFunction.meta* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StorageKey.ts#L14)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StorageKey.ts#L14)* ___ @@ -73,7 +73,7 @@ ___ *Inherited from StorageFunction.method* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StorageKey.ts#L15)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StorageKey.ts#L15)* ___ @@ -84,7 +84,7 @@ ___ *Inherited from StorageFunction.section* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StorageKey.ts#L16)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StorageKey.ts#L16)* ___ @@ -95,7 +95,7 @@ ___ *Inherited from StorageFunction.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StorageKey.ts#L17)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StorageKey.ts#L17)* #### Type declaration ▸(): `any` diff --git a/docs/api/interfaces/_rx_types_.submittableextrinsicfunction.md b/docs/api/interfaces/_rx_types_.submittableextrinsicfunction.md index 078d9fc9bc..bb1a7d45cf 100644 --- a/docs/api/interfaces/_rx_types_.submittableextrinsicfunction.md +++ b/docs/api/interfaces/_rx_types_.submittableextrinsicfunction.md @@ -11,7 +11,7 @@ ▸ **__call**(...args: *`any`[]*): `Method` -*Defined in [rx/types.ts:29](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/rx/types.ts#L29)* +*Defined in [rx/types.ts:29](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/rx/types.ts#L29)* **Parameters:** @@ -21,7 +21,7 @@ **Returns:** [SubmittableExtrinsic](../classes/_rx_submittableextrinsic_.submittableextrinsic.md) -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:28](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L28)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:28](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L28)* **Parameters:** @@ -41,7 +41,7 @@ *Inherited from MethodFunction.callIndex* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:30](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L30)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:30](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L30)* ___ @@ -52,7 +52,7 @@ ___ *Inherited from MethodFunction.meta* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:31](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L31)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:31](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L31)* ___ @@ -63,7 +63,7 @@ ___ *Inherited from MethodFunction.method* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:32](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L32)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:32](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L32)* ___ @@ -74,7 +74,7 @@ ___ *Inherited from MethodFunction.section* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:33](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L33)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:33](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L33)* ___ @@ -85,7 +85,7 @@ ___ *Inherited from MethodFunction.toJSON* -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L34)* +*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/Method.ts:34](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L34)* #### Type declaration ▸(): `any` diff --git a/docs/api/interfaces/_types_.apibaseinterface.md b/docs/api/interfaces/_types_.apibaseinterface.md index 9ab658273b..a791d71eb0 100644 --- a/docs/api/interfaces/_types_.apibaseinterface.md +++ b/docs/api/interfaces/_types_.apibaseinterface.md @@ -26,7 +26,7 @@ **● genesisHash**: *`Hash`* -*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L13)* ___ @@ -35,7 +35,7 @@ ___ **● hasSubscriptions**: *`boolean`* -*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L14)* ___ @@ -44,7 +44,7 @@ ___ **● on**: *`function`* -*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L21)* #### Type declaration ▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `void` @@ -65,7 +65,7 @@ ___ **● query**: *`S`* -*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L17)* ___ @@ -74,7 +74,7 @@ ___ **● rpc**: *`R`* -*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L18)* ___ @@ -83,7 +83,7 @@ ___ **● runtimeMetadata**: *`Metadata`* -*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L15)* ___ @@ -92,7 +92,7 @@ ___ **● runtimeVersion**: *`RuntimeVersion`* -*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L16)* ___ @@ -101,7 +101,7 @@ ___ **● tx**: *`E`* -*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L19)* ___ diff --git a/docs/api/interfaces/_types_.apioptions.md b/docs/api/interfaces/_types_.apioptions.md index 0889ee38ce..0123ddf629 100644 --- a/docs/api/interfaces/_types_.apioptions.md +++ b/docs/api/interfaces/_types_.apioptions.md @@ -12,7 +12,7 @@ **● provider**: *`ProviderInterface`* -*Defined in [types.ts:29](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L29)* +*Defined in [types.ts:29](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L29)* *__description__*: Transport Provider from rpc-provider. If not specified, it will default to connecting to a WsProvider connecting localhost with the default port, i.e. `ws://127.0.0.1:9944` @@ -24,7 +24,7 @@ ___ **● types**: * `undefined` | `object` * -*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L34)* +*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L34)* *__description__*: Additional types used by runtime modules. This is nessusary if the runtime modules uses types not available in the base Substrate runtime. diff --git a/docs/api/modules/_promise_combinator_.md b/docs/api/modules/_promise_combinator_.md index 38dd3d4841..61167b22c4 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:7](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/promise/Combinator.ts#L7)* +*Defined in [promise/Combinator.ts:7](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/promise/Combinator.ts#L7)* #### Type declaration ▸(value: *`Array`<`any`>*): `any` @@ -41,7 +41,7 @@ ___ **Ƭ CombinatorFunction**: *`function`* -*Defined in [promise/Combinator.ts:8](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/promise/Combinator.ts#L8)* +*Defined in [promise/Combinator.ts:8](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/promise/Combinator.ts#L8)* #### Type declaration ▸(cb: *`function`*): `Promise`<`any`> diff --git a/docs/api/modules/_promise_types_.md b/docs/api/modules/_promise_types_.md index 70b4c244c3..86469abe58 100644 --- a/docs/api/modules/_promise_types_.md +++ b/docs/api/modules/_promise_types_.md @@ -26,7 +26,7 @@ **Ƭ SubmittableSendResult**: *`object`* -*Defined in [promise/types.ts:47](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/promise/types.ts#L47)* +*Defined in [promise/types.ts:47](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/promise/types.ts#L47)* #### Type declaration diff --git a/docs/api/modules/_rx_types_.md b/docs/api/modules/_rx_types_.md index 72839f02d8..3b32e3cf9a 100644 --- a/docs/api/modules/_rx_types_.md +++ b/docs/api/modules/_rx_types_.md @@ -26,7 +26,7 @@ **Ƭ SubmittableSendResult**: *`object`* -*Defined in [rx/types.ts:46](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/rx/types.ts#L46)* +*Defined in [rx/types.ts:46](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/rx/types.ts#L46)* #### Type declaration diff --git a/docs/api/modules/_types_.md b/docs/api/modules/_types_.md index 157ed2aabd..72daf399a3 100644 --- a/docs/api/modules/_types_.md +++ b/docs/api/modules/_types_.md @@ -23,7 +23,7 @@ **Ƭ ApiInterface$Events**: * `RpcRxInterface$Events` | "ready" * -*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L10)* ___ @@ -32,7 +32,7 @@ ___ **Ƭ SubmittableSendResult**: *`object`* -*Defined in [types.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/api/src/types.ts#L37)* +*Defined in [types.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/api/src/types.ts#L37)* #### Type declaration diff --git a/docs/api/modules/_util_filterevents_.md b/docs/api/modules/_util_filterevents_.md index 177534075e..be47493e97 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/e79c6d8/packages/api/src/util/filterEvents.ts#L9)* +*Defined in [util/filterEvents.ts:9](https://github.com/polkadot-js/api/blob/e802b8e/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 5f73c2ae14..d5b93d28ab 100644 --- a/docs/examples/promise/01_simple_connect/index.html +++ b/docs/examples/promise/01_simple_connect/index.html @@ -2028,7 +2028,7 @@
diff --git a/docs/examples/promise/02_listen_to_blocks/index.html b/docs/examples/promise/02_listen_to_blocks/index.html index a9de0a1ced..686fd31fb3 100644 --- a/docs/examples/promise/02_listen_to_blocks/index.html +++ b/docs/examples/promise/02_listen_to_blocks/index.html @@ -2030,7 +2030,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 7df403bfbc..7a6abff275 100644 --- a/docs/examples/promise/03_listen_to_balance_change/index.html +++ b/docs/examples/promise/03_listen_to_balance_change/index.html @@ -2041,7 +2041,7 @@
diff --git a/docs/examples/promise/05_read_storage/index.html b/docs/examples/promise/05_read_storage/index.html index 93752cc325..132c901f47 100644 --- a/docs/examples/promise/05_read_storage/index.html +++ b/docs/examples/promise/05_read_storage/index.html @@ -2040,7 +2040,7 @@
diff --git a/docs/examples/promise/07_transfer_dots/index.html b/docs/examples/promise/07_transfer_dots/index.html index 804089d0f0..09f7c043ab 100644 --- a/docs/examples/promise/07_transfer_dots/index.html +++ b/docs/examples/promise/07_transfer_dots/index.html @@ -2042,7 +2042,7 @@
diff --git a/docs/examples/promise/08_system_events/index.html b/docs/examples/promise/08_system_events/index.html index 6c0f6bce70..6ef41fac94 100644 --- a/docs/examples/promise/08_system_events/index.html +++ b/docs/examples/promise/08_system_events/index.html @@ -2039,7 +2039,7 @@
diff --git a/docs/examples/promise/index.html b/docs/examples/promise/index.html index 347a9b0d49..698fab6725 100644 --- a/docs/examples/promise/index.html +++ b/docs/examples/promise/index.html @@ -2018,7 +2018,7 @@
diff --git a/docs/index.html b/docs/index.html index 7ee819fc49..5c55e67f09 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2011,7 +2011,7 @@
diff --git a/docs/rpc-core/classes/_index_.rpc.md b/docs/rpc-core/classes/_index_.rpc.md index f7da42f592..01618dc5e1 100644 --- a/docs/rpc-core/classes/_index_.rpc.md +++ b/docs/rpc-core/classes/_index_.rpc.md @@ -38,7 +38,7 @@ const api = new Api(provider); ⊕ **new Rpc**(provider?: *`ProviderInterface`*): [Rpc](_index_.rpc.md) -*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-core/src/index.ts#L46)* +*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-core/src/index.ts#L46)* *__constructor__*: Default constructor for the Api Object @@ -60,7 +60,7 @@ ___ **● _provider**: *`ProviderInterface`* -*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-core/src/index.ts#L42)* +*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-core/src/index.ts#L42)* ___ @@ -71,7 +71,7 @@ ___ *Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[author](../interfaces/_types_.rpcinterface.md#author)* -*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-core/src/index.ts#L43)* +*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-core/src/index.ts#L43)* ___ @@ -82,7 +82,7 @@ ___ *Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[chain](../interfaces/_types_.rpcinterface.md#chain)* -*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-core/src/index.ts#L44)* +*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-core/src/index.ts#L44)* ___ @@ -93,7 +93,7 @@ ___ *Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[state](../interfaces/_types_.rpcinterface.md#state)* -*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-core/src/index.ts#L45)* +*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-core/src/index.ts#L45)* ___ @@ -104,7 +104,7 @@ ___ *Implementation of [RpcInterface](../interfaces/_types_.rpcinterface.md).[system](../interfaces/_types_.rpcinterface.md#system)* -*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-core/src/index.ts#L46)* +*Defined in [index.ts:46](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-core/src/index.ts#L46)* ___ @@ -116,7 +116,7 @@ ___ ▸ **signature**(__namedParameters: *`object`*): `string` -*Defined in [index.ts:79](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-core/src/index.ts#L79)* +*Defined in [index.ts:79](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-core/src/index.ts#L79)* *__name__*: signature diff --git a/docs/rpc-core/interfaces/_types_.rpcinterface.md b/docs/rpc-core/interfaces/_types_.rpcinterface.md index 00662fb42a..b0a639b1e8 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/e79c6d8/packages/rpc-core/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/e802b8e/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/e79c6d8/packages/rpc-core/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/e802b8e/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/e79c6d8/packages/rpc-core/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/e802b8e/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/e79c6d8/packages/rpc-core/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-core/src/types.ts#L20)* ___ diff --git a/docs/rpc-core/interfaces/_types_.rpcinterface_section_method.md b/docs/rpc-core/interfaces/_types_.rpcinterface_section_method.md index 8c607681a7..99b8ce4f35 100644 --- a/docs/rpc-core/interfaces/_types_.rpcinterface_section_method.md +++ b/docs/rpc-core/interfaces/_types_.rpcinterface_section_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/e79c6d8/packages/rpc-core/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/e802b8e/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/e79c6d8/packages/rpc-core/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/e802b8e/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/e79c6d8/packages/rpc-core/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/e802b8e/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 96bd0359df..f8c3f0c31c 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/e79c6d8/packages/rpc-core/src/types.ts#L12)* +*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/e802b8e/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 0555a44056..fb1126e41f 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/e79c6d8/packages/rpc-provider/src/coder/index.ts#L12)* +*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/e802b8e/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/e79c6d8/packages/rpc-provider/src/coder/index.ts#L33)* +*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/e802b8e/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/e79c6d8/packages/rpc-provider/src/coder/index.ts#L39)* +*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/e802b8e/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/e79c6d8/packages/rpc-provider/src/coder/index.ts#L48)* +*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/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 a8fbca9703..e2b82f9c56 100644 --- a/docs/rpc-provider/classes/_http_index_.httpprovider.html +++ b/docs/rpc-provider/classes/_http_index_.httpprovider.html @@ -1981,7 +1981,7 @@

constructor

⊕ new HttpProvider(endpoint?: string): HttpProvider

-

Defined in http/index.ts:40

+

Defined in http/index.ts:40

Parameters:

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


@@ -2016,7 +2016,7 @@

isConnected

▸ isConnected(): boolean

Implementation of ProviderInterface.isConnected

-

Defined in http/index.ts:63

+

Defined in http/index.ts:63

summary: Whether the node is connected or not.

Returns: boolean true if connected

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

on

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

Implementation of ProviderInterface.on

-

Defined in http/index.ts:71

+

Defined in http/index.ts:71

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

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

Parameters:

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

send

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

Implementation of ProviderInterface.send

-

Defined in http/index.ts:78

+

Defined in http/index.ts:78

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

Parameters:

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

subscribe

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

Implementation of ProviderInterface.subscribe

-

Defined in http/index.ts:100

+

Defined in http/index.ts:100

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

Parameters:

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

unsubscribe

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

Implementation of ProviderInterface.unsubscribe

-

Defined in http/index.ts:109

+

Defined in http/index.ts:109

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

Parameters:

@@ -2185,7 +2185,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 d7946ce7f2..f7d8381b5f 100644 --- a/docs/rpc-provider/classes/_http_index_.httpprovider.md +++ b/docs/rpc-provider/classes/_http_index_.httpprovider.md @@ -34,7 +34,7 @@ const api = new Api(provider); ⊕ **new HttpProvider**(endpoint?: *`string`*): [HttpProvider](_http_index_.httpprovider.md) -*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/http/index.ts#L40)* +*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/http/index.ts#L40)* **Parameters:** @@ -54,7 +54,7 @@ ___ gethasSubscriptions(): `boolean` -*Defined in [http/index.ts:55](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/http/index.ts#L55)* +*Defined in [http/index.ts:55](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/http/index.ts#L55)* *__summary__*: `true` when this provider supports subscriptions @@ -72,7 +72,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)* -*Defined in [http/index.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/http/index.ts#L63)* +*Defined in [http/index.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/http/index.ts#L63)* *__summary__*: Whether the node is connected or not. @@ -88,7 +88,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)* -*Defined in [http/index.ts:71](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/http/index.ts#L71)* +*Defined in [http/index.ts:71](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/http/index.ts#L71)* *__summary__*: Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). @@ -112,7 +112,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)* -*Defined in [http/index.ts:78](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/http/index.ts#L78)* +*Defined in [http/index.ts:78](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/http/index.ts#L78)* *__summary__*: Send HTTP POST Request with Body to configured HTTP Endpoint. @@ -134,7 +134,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[subscribe](../interfaces/_types_.providerinterface.md#subscribe)* -*Defined in [http/index.ts:100](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/http/index.ts#L100)* +*Defined in [http/index.ts:100](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/http/index.ts#L100)* *__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). @@ -158,7 +158,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)* -*Defined in [http/index.ts:109](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/http/index.ts#L109)* +*Defined in [http/index.ts:109](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/http/index.ts#L109)* *__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md). diff --git a/docs/rpc-provider/classes/_mock_index_.mock.md b/docs/rpc-provider/classes/_mock_index_.mock.md index f4d2c6d3e5..c0c7f9d282 100644 --- a/docs/rpc-provider/classes/_mock_index_.mock.md +++ b/docs/rpc-provider/classes/_mock_index_.mock.md @@ -19,7 +19,7 @@ A mock provider mainly used for testing. ⊕ **new Mock**(): [Mock](_mock_index_.mock.md) -*Defined in [mock/index.ts:64](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/mock/index.ts#L64)* +*Defined in [mock/index.ts:64](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/mock/index.ts#L64)* **Returns:** [Mock](_mock_index_.mock.md) @@ -33,7 +33,7 @@ ___ **● isUpdating**: *`boolean`* = true -*Defined in [mock/index.ts:42](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/mock/index.ts#L42)* +*Defined in [mock/index.ts:42](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/mock/index.ts#L42)* ___ @@ -49,7 +49,7 @@ ___ return subs; }, ({} as MockState$Subscriptions)) -*Defined in [mock/index.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/mock/index.ts#L53)* +*Defined in [mock/index.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/mock/index.ts#L53)* ___ @@ -61,7 +61,7 @@ ___ gethasSubscriptions(): `boolean` -*Defined in [mock/index.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/mock/index.ts#L70)* +*Defined in [mock/index.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/mock/index.ts#L70)* **Returns:** `boolean` @@ -77,7 +77,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)* -*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/mock/index.ts#L74)* +*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/mock/index.ts#L74)* **Returns:** `boolean` @@ -90,7 +90,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)* -*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/mock/index.ts#L78)* +*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/mock/index.ts#L78)* **Parameters:** @@ -110,7 +110,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)* -*Defined in [mock/index.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/mock/index.ts#L82)* +*Defined in [mock/index.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/mock/index.ts#L82)* **Parameters:** @@ -128,7 +128,7 @@ ___ ▸ **subscribe**(type: *`string`*, method: *`string`*, ...params: *`Array`<`any`>*): `Promise`<`number`> -*Defined in [mock/index.ts:90](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/mock/index.ts#L90)* +*Defined in [mock/index.ts:90](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/mock/index.ts#L90)* **Parameters:** @@ -149,7 +149,7 @@ ___ *Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)* -*Defined in [mock/index.ts:110](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/mock/index.ts#L110)* +*Defined in [mock/index.ts:110](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/mock/index.ts#L110)* **Parameters:** diff --git a/docs/rpc-provider/classes/_ws_index_.wsprovider.html b/docs/rpc-provider/classes/_ws_index_.wsprovider.html index 7faeae6f34..d0192881b0 100644 --- a/docs/rpc-provider/classes/_ws_index_.wsprovider.html +++ b/docs/rpc-provider/classes/_ws_index_.wsprovider.html @@ -1981,7 +1981,7 @@

constructor

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

-

Defined in ws/index.ts:75

+

Defined in ws/index.ts:75

Parameters:

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


@@ -2021,7 +2021,7 @@

connect

▸ connect(): void

-

Defined in ws/index.ts:110

+

Defined in ws/index.ts:110

summary: Manually connect

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

Returns: void

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

isConnected

▸ isConnected(): boolean

-

Defined in ws/index.ts:127

+

Defined in ws/index.ts:127

summary: Whether the node is connected or not.

Returns: boolean true if connected

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

on

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

-

Defined in ws/index.ts:136

+

Defined in ws/index.ts:136

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

Parameters:

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

send

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

-

Defined in ws/index.ts:146

+

Defined in ws/index.ts:146

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

Parameters:

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

subscribe

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

-

Defined in ws/index.ts:200

+

Defined in ws/index.ts:200

name: subscribe

summary: Allows subscribing to a specific event.

example:

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

unsubscribe

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

-

Defined in ws/index.ts:209

+

Defined in ws/index.ts:209

summary: Allows unsubscribing to subscriptions made with subscribe.

Parameters:

@@ -2221,7 +2221,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 8d9a9f8389..b37d192b4b 100644 --- a/docs/rpc-provider/classes/_ws_index_.wsprovider.md +++ b/docs/rpc-provider/classes/_ws_index_.wsprovider.md @@ -34,7 +34,7 @@ const api = new Api(provider); ⊕ **new WsProvider**(endpoint?: *`string`*, autoConnect?: *`boolean`*): [WsProvider](_ws_index_.wsprovider.md) -*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/ws/index.ts#L75)* +*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/ws/index.ts#L75)* **Parameters:** @@ -55,7 +55,7 @@ ___ gethasSubscriptions(): `boolean` -*Defined in [ws/index.ts:101](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/ws/index.ts#L101)* +*Defined in [ws/index.ts:101](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/ws/index.ts#L101)* *__summary__*: `true` when this provider supports subscriptions @@ -71,7 +71,7 @@ ___ ▸ **connect**(): `void` -*Defined in [ws/index.ts:110](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/ws/index.ts#L110)* +*Defined in [ws/index.ts:110](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/ws/index.ts#L110)* *__summary__*: Manually connect @@ -86,7 +86,7 @@ ___ ▸ **isConnected**(): `boolean` -*Defined in [ws/index.ts:127](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/ws/index.ts#L127)* +*Defined in [ws/index.ts:127](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/ws/index.ts#L127)* *__summary__*: Whether the node is connected or not. @@ -100,7 +100,7 @@ ___ ▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void` -*Defined in [ws/index.ts:136](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/ws/index.ts#L136)* +*Defined in [ws/index.ts:136](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/ws/index.ts#L136)* *__summary__*: Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function. @@ -120,7 +120,7 @@ ___ ▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`> -*Defined in [ws/index.ts:146](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/ws/index.ts#L146)* +*Defined in [ws/index.ts:146](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/ws/index.ts#L146)* *__summary__*: Send JSON data using WebSockets to configured HTTP Endpoint or queue. @@ -141,7 +141,7 @@ ___ ▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`> -*Defined in [ws/index.ts:200](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/ws/index.ts#L200)* +*Defined in [ws/index.ts:200](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/ws/index.ts#L200)* *__name__*: subscribe @@ -179,7 +179,7 @@ ___ ▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> -*Defined in [ws/index.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/ws/index.ts#L209)* +*Defined in [ws/index.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/ws/index.ts#L209)* *__summary__*: Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe). diff --git a/docs/rpc-provider/index.html b/docs/rpc-provider/index.html index cd17462501..98576566c8 100644 --- a/docs/rpc-provider/index.html +++ b/docs/rpc-provider/index.html @@ -2029,7 +2029,7 @@ diff --git a/docs/rpc-provider/interfaces/_types_.providerinterface.md b/docs/rpc-provider/interfaces/_types_.providerinterface.md index a0affffd26..5adff1e67b 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/e79c6d8/packages/rpc-provider/src/types.ts#L45)* +*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/types.ts#L45)* ___ @@ -29,7 +29,7 @@ ___ ▸ **isConnected**(): `boolean` -*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/types.ts#L46)* +*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/types.ts#L46)* **Returns:** `boolean` @@ -40,7 +40,7 @@ ___ ▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void` -*Defined in [types.ts:47](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/types.ts#L47)* +*Defined in [types.ts:47](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/types.ts#L47)* **Parameters:** @@ -58,7 +58,7 @@ ___ ▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`> -*Defined in [types.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/types.ts#L48)* +*Defined in [types.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/types.ts#L48)* **Parameters:** @@ -76,7 +76,7 @@ ___ ▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`> -*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/types.ts#L49)* +*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/types.ts#L49)* **Parameters:** @@ -96,7 +96,7 @@ ___ ▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> -*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/types.ts#L50)* +*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/types.ts#L50)* **Parameters:** diff --git a/docs/rpc-provider/modules/_http_types_.md b/docs/rpc-provider/modules/_http_types_.md index 5ea6f295d8..71209b76ef 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/e79c6d8/packages/rpc-provider/src/http/types.ts#L9)* +*Defined in [http/types.ts:9](https://github.com/polkadot-js/api/blob/e802b8e/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 0e3d6380d4..67fd989834 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/e79c6d8/packages/rpc-provider/src/mock/types.ts#L16)* +*Defined in [mock/types.ts:16](https://github.com/polkadot-js/api/blob/e802b8e/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/e79c6d8/packages/rpc-provider/src/mock/types.ts#L20)* +*Defined in [mock/types.ts:20](https://github.com/polkadot-js/api/blob/e802b8e/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/e79c6d8/packages/rpc-provider/src/mock/types.ts#L5)* +*Defined in [mock/types.ts:5](https://github.com/polkadot-js/api/blob/e802b8e/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/e79c6d8/packages/rpc-provider/src/mock/types.ts#L7)* +*Defined in [mock/types.ts:7](https://github.com/polkadot-js/api/blob/e802b8e/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 96ab8977e5..bed1efdb09 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/e79c6d8/packages/rpc-provider/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/types.ts#L5)* #### Type declaration @@ -39,7 +39,7 @@ ___ **Ƭ JsonRpcRequest**: * [JsonRpcObject](_types_.md#jsonrpcobject) & `object` * -*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/types.ts#L10)* ___ @@ -49,7 +49,7 @@ ___ **Ƭ JsonRpcResponse**: * [JsonRpcObject](_types_.md#jsonrpcobject) & [JsonRpcResponseBase](_types_.md#jsonrpcresponsebase) * -*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/types.ts#L36)* +*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/types.ts#L36)* ___ @@ -59,7 +59,7 @@ ___ **Ƭ JsonRpcResponseBase**: * `JsonRpcResponse$Single` & `JsonRpcResponse$Subscription` * -*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/types.ts#L34)* +*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/types.ts#L34)* ___ @@ -68,7 +68,7 @@ ___ **Ƭ JsonRpcResponseBase$Error**: *`object`* -*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/types.ts#L15)* #### Type declaration @@ -79,7 +79,7 @@ ___ **Ƭ ProviderInterface$Callback**: *`function`* -*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/types.ts#L38)* +*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/types.ts#L38)* #### Type declaration ▸(result: *`any`*): `void` @@ -99,7 +99,7 @@ ___ **Ƭ ProviderInterface$EmitCb**: *`function`* -*Defined in [types.ts:42](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/types.ts#L42)* +*Defined in [types.ts:42](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-provider/src/types.ts#L42)* #### Type declaration ▸(value?: *`any`*): `any` @@ -120,7 +120,7 @@ ___ **Ƭ ProviderInterface$Emitted**: * "connected" | "disconnected" | "error" * -*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-provider/src/types.ts#L40)* +*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/e802b8e/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 e9eea66b15..eac48b0d5f 100644 --- a/docs/rpc-rx/classes/_index_.rpcrx.md +++ b/docs/rpc-rx/classes/_index_.rpcrx.md @@ -32,7 +32,7 @@ const api = new RpcRx(provider); ⊕ **new RpcRx**(providerOrRpc?: * `Rpc` | `ProviderInterface`*): [RpcRx](_index_.rpcrx.md) -*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-rx/src/index.ts#L45)* +*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-rx/src/index.ts#L45)* **Parameters:** @@ -52,7 +52,7 @@ ___ **● author**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)* -*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-rx/src/index.ts#L42)* +*Defined in [index.ts:42](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-rx/src/index.ts#L42)* ___ @@ -61,7 +61,7 @@ ___ **● chain**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)* -*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-rx/src/index.ts#L43)* +*Defined in [index.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-rx/src/index.ts#L43)* ___ @@ -70,7 +70,7 @@ ___ **● state**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)* -*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-rx/src/index.ts#L44)* +*Defined in [index.ts:44](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-rx/src/index.ts#L44)* ___ @@ -79,7 +79,7 @@ ___ **● system**: *[RpcRxInterface$Section](../modules/_types_.md#rpcrxinterface_section)* -*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-rx/src/index.ts#L45)* +*Defined in [index.ts:45](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-rx/src/index.ts#L45)* ___ @@ -91,7 +91,7 @@ ___ ▸ **isConnected**(): `BehaviorSubject`<`boolean`> -*Defined in [index.ts:66](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-rx/src/index.ts#L66)* +*Defined in [index.ts:66](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-rx/src/index.ts#L66)* **Returns:** `BehaviorSubject`<`boolean`> @@ -102,7 +102,7 @@ ___ ▸ **on**(type: *[RpcRxInterface$Events](../modules/_types_.md#rpcrxinterface_events)*, handler: *`function`*): `void` -*Defined in [index.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-rx/src/index.ts#L70)* +*Defined in [index.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-rx/src/index.ts#L70)* **Parameters:** diff --git a/docs/rpc-rx/modules/_types_.md b/docs/rpc-rx/modules/_types_.md index 333f8df790..1a4fa19917 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/e79c6d8/packages/rpc-rx/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/e802b8e/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/e79c6d8/packages/rpc-rx/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/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/e79c6d8/packages/rpc-rx/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/e802b8e/packages/rpc-rx/src/types.ts#L8)* #### Type declaration ▸(...params: *`Array`<`any`>*): `Observable`<`any`> | `ReplaySubject`<`any`> @@ -48,7 +48,7 @@ ___ **Ƭ RpcRxInterface$Section**: *`object`* -*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/e79c6d8/packages/rpc-rx/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/e802b8e/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 b9912f0bf5..92e425e429 100644 --- a/docs/type-extrinsics/modules/_frommetadata_.md +++ b/docs/type-extrinsics/modules/_frommetadata_.md @@ -8,7 +8,7 @@ ▸ **fromMetadata**(metadata: *`Metadata`*): `ModulesWithMethods` -*Defined in [fromMetadata.ts:21](https://github.com/polkadot-js/api/blob/e79c6d8/packages/type-extrinsics/src/fromMetadata.ts#L21)* +*Defined in [fromMetadata.ts:21](https://github.com/polkadot-js/api/blob/e802b8e/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 b109008f26..0f84111a69 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/e79c6d8/packages/type-extrinsics/src/utils/createUnchecked.ts#L16)* +*Defined in [utils/createUnchecked.ts:16](https://github.com/polkadot-js/api/blob/e802b8e/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 f61c024c2b..b6a4a4600d 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/e79c6d8/packages/type-jsonrpc/src/create/method.ts#L9)* +*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/e802b8e/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 7ac7eca546..456114ba7e 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/e79c6d8/packages/type-jsonrpc/src/create/param.ts#L12)* +*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/e802b8e/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 11e3e18c6e..0516d4ad50 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/e79c6d8/packages/type-jsonrpc/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/e802b8e/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/e79c6d8/packages/type-jsonrpc/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/e802b8e/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/e79c6d8/packages/type-jsonrpc/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/e802b8e/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/e79c6d8/packages/type-jsonrpc/src/types.ts#L38)* +*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/e802b8e/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 649c145056..052e1b0138 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/e79c6d8/packages/type-storage/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/e802b8e/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 6479c6dc7c..74e2876eaa 100644 --- a/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md +++ b/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md @@ -13,7 +13,7 @@ **● isUnhashed**: * `undefined` | `false` | `true` * -*Defined in [utils/createFunction.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/type-storage/src/utils/createFunction.ts#L14)* +*Defined in [utils/createFunction.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/type-storage/src/utils/createFunction.ts#L14)* ___ @@ -23,7 +23,7 @@ ___ **● key**: * `undefined` | `string` * -*Defined in [utils/createFunction.ts:15](https://github.com/polkadot-js/api/blob/e79c6d8/packages/type-storage/src/utils/createFunction.ts#L15)* +*Defined in [utils/createFunction.ts:15](https://github.com/polkadot-js/api/blob/e802b8e/packages/type-storage/src/utils/createFunction.ts#L15)* ___ diff --git a/docs/type-storage/modules/_frommetadata_.md b/docs/type-storage/modules/_frommetadata_.md index 5bed391149..d9c9905386 100644 --- a/docs/type-storage/modules/_frommetadata_.md +++ b/docs/type-storage/modules/_frommetadata_.md @@ -8,7 +8,7 @@ ▸ **fromMetadata**(metadata: *`Metadata`*): [Storage](../interfaces/_types_.storage.md) -*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/e79c6d8/packages/type-storage/src/fromMetadata.ts#L20)* +*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/e802b8e/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 083b08a1c0..d46f332d91 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/e79c6d8/packages/type-storage/src/storage.ts#L8)* +*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/e802b8e/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/e79c6d8/packages/type-storage/src/storage.ts#L9)* +*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/e802b8e/packages/type-storage/src/storage.ts#L9)* ___ diff --git a/docs/type-storage/modules/_substrate_.md b/docs/type-storage/modules/_substrate_.md index ad677786dc..ae207666f8 100644 --- a/docs/type-storage/modules/_substrate_.md +++ b/docs/type-storage/modules/_substrate_.md @@ -11,7 +11,7 @@ type: 'u32' }) -*Defined in [substrate.ts:45](https://github.com/polkadot-js/api/blob/e79c6d8/packages/type-storage/src/substrate.ts#L45)* +*Defined in [substrate.ts:45](https://github.com/polkadot-js/api/blob/e802b8e/packages/type-storage/src/substrate.ts#L45)* ___ @@ -23,7 +23,7 @@ ___ type: 'u32' }) -*Defined in [substrate.ts:50](https://github.com/polkadot-js/api/blob/e79c6d8/packages/type-storage/src/substrate.ts#L50)* +*Defined in [substrate.ts:50](https://github.com/polkadot-js/api/blob/e802b8e/packages/type-storage/src/substrate.ts#L50)* ___ @@ -35,7 +35,7 @@ ___ type: 'u32' }) -*Defined in [substrate.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/type-storage/src/substrate.ts#L60)* +*Defined in [substrate.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/type-storage/src/substrate.ts#L60)* ___ @@ -47,7 +47,7 @@ ___ type: 'Bytes' }) -*Defined in [substrate.ts:35](https://github.com/polkadot-js/api/blob/e79c6d8/packages/type-storage/src/substrate.ts#L35)* +*Defined in [substrate.ts:35](https://github.com/polkadot-js/api/blob/e802b8e/packages/type-storage/src/substrate.ts#L35)* ___ @@ -59,7 +59,7 @@ ___ type: 'u32' }) -*Defined in [substrate.ts:55](https://github.com/polkadot-js/api/blob/e79c6d8/packages/type-storage/src/substrate.ts#L55)* +*Defined in [substrate.ts:55](https://github.com/polkadot-js/api/blob/e802b8e/packages/type-storage/src/substrate.ts#L55)* ___ @@ -71,7 +71,7 @@ ___ type: 'u64' }) -*Defined in [substrate.ts:40](https://github.com/polkadot-js/api/blob/e79c6d8/packages/type-storage/src/substrate.ts#L40)* +*Defined in [substrate.ts:40](https://github.com/polkadot-js/api/blob/e802b8e/packages/type-storage/src/substrate.ts#L40)* ___ diff --git a/docs/type-storage/modules/_utils_createfunction_.md b/docs/type-storage/modules/_utils_createfunction_.md index 5b0b1309d7..2603604f12 100644 --- a/docs/type-storage/modules/_utils_createfunction_.md +++ b/docs/type-storage/modules/_utils_createfunction_.md @@ -20,7 +20,7 @@ ▸ **createFunction**(section: * `Text` | `string`*, method: * `Text` | `string`*, meta: *`StorageFunctionMetadata`*, options?: *[CreateItemOptions](../interfaces/_utils_createfunction_.createitemoptions.md)*): `StorageFunction` -*Defined in [utils/createFunction.ts:28](https://github.com/polkadot-js/api/blob/e79c6d8/packages/type-storage/src/utils/createFunction.ts#L28)* +*Defined in [utils/createFunction.ts:28](https://github.com/polkadot-js/api/blob/e802b8e/packages/type-storage/src/utils/createFunction.ts#L28)* From the schema of a function in the module's storage, generate the function that will return the correct storage key. diff --git a/docs/types/classes/_accountid_.accountid.html b/docs/types/classes/_accountid_.accountid.html index b62b8000b7..fa4f817848 100644 --- a/docs/types/classes/_accountid_.accountid.html +++ b/docs/types/classes/_accountid_.accountid.html @@ -1977,7 +1977,7 @@

constructor

⊕ new AccountId(value?: AnyU8a): AccountId

Overrides U8aFixed.constructor

-

Defined in AccountId.ts:19

+

Defined in AccountId.ts:19

Parameters:

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


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

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


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

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2729,7 +2729,7 @@

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

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

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

Parameters:

@@ -2760,7 +2760,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2769,7 +2769,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Overrides U8a.toJSON

-

Defined in AccountId.ts:46

+

Defined in AccountId.ts:46

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

Returns: any


@@ -2786,7 +2786,7 @@

▸ toString(): string

Implementation of Codec.toString

Overrides U8a.toString

-

Defined in AccountId.ts:53

+

Defined in AccountId.ts:53

description: Returns the string representation of the value

Returns: string


@@ -2794,7 +2794,7 @@

toU8a

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

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

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

Parameters:

@@ -2826,7 +2826,7 @@

<Static> encode

▸ encode(value: Uint8Array): string

-

Defined in AccountId.ts:27

+

Defined in AccountId.ts:27

Parameters:

@@ -2887,7 +2887,7 @@ diff --git a/docs/types/classes/_accountid_.accountid.md b/docs/types/classes/_accountid_.accountid.md index 9e1244d87c..9531452d35 100644 --- a/docs/types/classes/_accountid_.accountid.md +++ b/docs/types/classes/_accountid_.accountid.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/AccountId.ts#L19)* +*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/AccountId.ts#L19)* **Parameters:** @@ -117,7 +117,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -134,7 +134,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -165,7 +165,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -691,7 +691,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -715,7 +715,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -732,7 +732,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/AccountId.ts#L46)* +*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/AccountId.ts#L46)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -764,7 +764,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/AccountId.ts#L53)* +*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/AccountId.ts#L53)* *__description__*: Returns the string representation of the value @@ -779,7 +779,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -813,7 +813,7 @@ ___ ▸ **encode**(value: *`Uint8Array`*): `string` -*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/AccountId.ts#L27)* +*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/AccountId.ts#L27)* **Parameters:** diff --git a/docs/types/classes/_accountindex_.accountindex.html b/docs/types/classes/_accountindex_.accountindex.html index 4eafc7518b..34bcc03186 100644 --- a/docs/types/classes/_accountindex_.accountindex.html +++ b/docs/types/classes/_accountindex_.accountindex.html @@ -1974,7 +1974,7 @@

constructor

⊕ new AccountIndex(value?: AnyNumber): AccountIndex

Overrides U32.constructor

-

Defined in AccountIndex.ts:29

+

Defined in AccountIndex.ts:29

Parameters:

@@ -1999,7 +1999,7 @@

encodedLength

getencodedLength(): number

Inherited from AbstractInt.encodedLength

-

Defined in codec/AbstractInt.ts:56

+

Defined in codec/AbstractInt.ts:56

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

Returns: number


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

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

-

Defined in codec/AbstractInt.ts:63

+

Defined in codec/AbstractInt.ts:63

description: Returns the number of bits in the value

Returns: UIntBitLength


@@ -3510,7 +3510,7 @@

toBn

▸ toBn(): BN

Overrides AbstractInt.toBn

-

Defined in AccountIndex.ts:92

+

Defined in AccountIndex.ts:92

description: Returns the BN representation of the AccountIndex

Returns: BN


@@ -3546,7 +3546,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Overrides UInt.toHex

-

Defined in AccountIndex.ts:99

+

Defined in AccountIndex.ts:99

description: Returns a hex string representation of the value

Returns: string


@@ -3555,7 +3555,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Overrides AbstractInt.toJSON

-

Defined in AccountIndex.ts:108

+

Defined in AccountIndex.ts:108

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

Returns: any


@@ -3595,7 +3595,7 @@

▸ toString(): string

Implementation of Codec.toString

Overrides AbstractInt.toString

-

Defined in AccountIndex.ts:115

+

Defined in AccountIndex.ts:115

description: Returns the string representation of the value

Returns: string


@@ -3627,7 +3627,7 @@

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

Implementation of Codec.toU8a

Overrides UInt.toU8a

-

Defined in AccountIndex.ts:126

+

Defined in AccountIndex.ts:126

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

Parameters:

@@ -3848,7 +3848,7 @@

<Static> calcLength

▸ calcLength(_value: BN | number): number

-

Defined in AccountIndex.ts:52

+

Defined in AccountIndex.ts:52

Parameters:

@@ -3870,7 +3870,7 @@

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

-

Defined in codec/AbstractInt.ts:37

+

Defined in codec/AbstractInt.ts:37

Parameters:

@@ -3899,7 +3899,7 @@

<Static> decodeAccountIndex

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

-

Defined in AccountIndex.ts:36

+

Defined in AccountIndex.ts:36

Parameters:

@@ -4020,7 +4020,7 @@

<Static> readLength

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

-

Defined in AccountIndex.ts:66

+

Defined in AccountIndex.ts:66

Parameters:

@@ -4064,7 +4064,7 @@

<Static> writeLength

▸ writeLength(input: Uint8Array): Uint8Array

-

Defined in AccountIndex.ts:80

+

Defined in AccountIndex.ts:80

Parameters:

@@ -4125,7 +4125,7 @@ diff --git a/docs/types/classes/_accountindex_.accountindex.md b/docs/types/classes/_accountindex_.accountindex.md index e706ebd9cc..f1df80827d 100644 --- a/docs/types/classes/_accountindex_.accountindex.md +++ b/docs/types/classes/_accountindex_.accountindex.md @@ -24,7 +24,7 @@ *Overrides [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)* -*Defined in [AccountIndex.ts:29](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/AccountIndex.ts#L29)* +*Defined in [AccountIndex.ts:29](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/AccountIndex.ts#L29)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -186,7 +186,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1521,7 +1521,7 @@ ___ *Overrides AbstractInt.toBn* -*Defined in [AccountIndex.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/AccountIndex.ts#L92)* +*Defined in [AccountIndex.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/AccountIndex.ts#L92)* *__description__*: Returns the BN representation of the AccountIndex @@ -1560,7 +1560,7 @@ ___ *Overrides [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* -*Defined in [AccountIndex.ts:99](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/AccountIndex.ts#L99)* +*Defined in [AccountIndex.ts:99](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/AccountIndex.ts#L99)* *__description__*: Returns a hex string representation of the value @@ -1577,7 +1577,7 @@ ___ *Overrides AbstractInt.toJSON* -*Defined in [AccountIndex.ts:108](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/AccountIndex.ts#L108)* +*Defined in [AccountIndex.ts:108](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/AccountIndex.ts#L108)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1630,7 +1630,7 @@ ___ *Overrides AbstractInt.toString* -*Defined in [AccountIndex.ts:115](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/AccountIndex.ts#L115)* +*Defined in [AccountIndex.ts:115](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/AccountIndex.ts#L115)* *__description__*: Returns the string representation of the value @@ -1668,7 +1668,7 @@ ___ *Overrides [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* -*Defined in [AccountIndex.ts:126](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/AccountIndex.ts#L126)* +*Defined in [AccountIndex.ts:126](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/AccountIndex.ts#L126)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1871,7 +1871,7 @@ ___ ▸ **calcLength**(_value: * `BN` | `number`*): `number` -*Defined in [AccountIndex.ts:52](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/AccountIndex.ts#L52)* +*Defined in [AccountIndex.ts:52](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/AccountIndex.ts#L52)* **Parameters:** @@ -1890,7 +1890,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** @@ -1909,7 +1909,7 @@ ___ ▸ **decodeAccountIndex**(value: *[AnyNumber](../modules/_types_.md#anynumber)*): `BN` | `Uint8Array` | `number` | `string` -*Defined in [AccountIndex.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/AccountIndex.ts#L36)* +*Defined in [AccountIndex.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/AccountIndex.ts#L36)* **Parameters:** @@ -2012,7 +2012,7 @@ ___ ▸ **readLength**(input: *`Uint8Array`*): [`number`, `number`] -*Defined in [AccountIndex.ts:66](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/AccountIndex.ts#L66)* +*Defined in [AccountIndex.ts:66](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/AccountIndex.ts#L66)* **Parameters:** @@ -2050,7 +2050,7 @@ ___ ▸ **writeLength**(input: *`Uint8Array`*): `Uint8Array` -*Defined in [AccountIndex.ts:80](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/AccountIndex.ts#L80)* +*Defined in [AccountIndex.ts:80](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/AccountIndex.ts#L80)* **Parameters:** diff --git a/docs/types/classes/_address_.address.html b/docs/types/classes/_address_.address.html index 681ca8a71f..e47b4615be 100644 --- a/docs/types/classes/_address_.address.html +++ b/docs/types/classes/_address_.address.html @@ -1970,7 +1970,7 @@

constructor

⊕ new Address(value?: AnyAddress): Address

Overrides Base.constructor

-

Defined in Address.ts:25

+

Defined in Address.ts:25

Parameters:

@@ -1994,14 +1994,14 @@

encodedLength

getencodedLength(): number

-

Defined in Address.ts:67

+

Defined in Address.ts:67

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

Returns: number


rawLength

getrawLength(): number

-

Defined in Address.ts:81

+

Defined in Address.ts:81

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

Returns: number


@@ -2009,28 +2009,28 @@

toHex

▸ toHex(): string

-

Defined in Address.ts:90

+

Defined in Address.ts:90

description: Returns a hex string representation of the value

Returns: string


toJSON

▸ toJSON(): any

-

Defined in Address.ts:97

+

Defined in Address.ts:97

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

Returns: any


toString

▸ toString(): string

-

Defined in Address.ts:104

+

Defined in Address.ts:104

description: Returns the string representation of the value

Returns: string


toU8a

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

-

Defined in Address.ts:112

+

Defined in Address.ts:112

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

Parameters:

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

<Static> decodeAddress

▸ decodeAddress(value: AnyAddress): AccountId | AccountIndex

-

Defined in Address.ts:32

+

Defined in Address.ts:32

Parameters:

@@ -2115,7 +2115,7 @@ diff --git a/docs/types/classes/_address_.address.md b/docs/types/classes/_address_.address.md index 434102b0a8..2b14fdddf3 100644 --- a/docs/types/classes/_address_.address.md +++ b/docs/types/classes/_address_.address.md @@ -20,7 +20,7 @@ *Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* -*Defined in [Address.ts:25](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Address.ts#L25)* +*Defined in [Address.ts:25](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Address.ts#L25)* **Parameters:** @@ -40,7 +40,7 @@ ___ getencodedLength(): `number` -*Defined in [Address.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Address.ts#L67)* +*Defined in [Address.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Address.ts#L67)* *__description__*: The length of the value when encoded as a Uint8Array @@ -53,7 +53,7 @@ ___ getrawLength(): `number` -*Defined in [Address.ts:81](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Address.ts#L81)* +*Defined in [Address.ts:81](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Address.ts#L81)* *__description__*: The length of the raw value, either AccountIndex or AccountId @@ -69,7 +69,7 @@ ___ ▸ **toHex**(): `string` -*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Address.ts#L90)* +*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Address.ts#L90)* *__description__*: Returns a hex string representation of the value @@ -82,7 +82,7 @@ ___ ▸ **toJSON**(): `any` -*Defined in [Address.ts:97](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Address.ts#L97)* +*Defined in [Address.ts:97](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Address.ts#L97)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -95,7 +95,7 @@ ___ ▸ **toString**(): `string` -*Defined in [Address.ts:104](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Address.ts#L104)* +*Defined in [Address.ts:104](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Address.ts#L104)* *__description__*: Returns the string representation of the value @@ -108,7 +108,7 @@ ___ ▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` -*Defined in [Address.ts:112](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Address.ts#L112)* +*Defined in [Address.ts:112](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Address.ts#L112)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -127,7 +127,7 @@ ___ ▸ **decodeAddress**(value: *`AnyAddress`*): [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md) -*Defined in [Address.ts:32](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Address.ts#L32)* +*Defined in [Address.ts:32](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Address.ts#L32)* **Parameters:** diff --git a/docs/types/classes/_attestedcandidate_.attestedcandidate.md b/docs/types/classes/_attestedcandidate_.attestedcandidate.md index c26e156aef..c466fb746d 100644 --- a/docs/types/classes/_attestedcandidate_.attestedcandidate.md +++ b/docs/types/classes/_attestedcandidate_.attestedcandidate.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [AttestedCandidate.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/AttestedCandidate.ts#L74)* +*Defined in [AttestedCandidate.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/AttestedCandidate.ts#L74)* **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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -193,7 +193,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -214,7 +214,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -289,7 +289,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -306,7 +306,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -323,7 +323,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -340,7 +340,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -355,7 +355,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -391,7 +391,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_attestedcandidate_.availabilityvote.md b/docs/types/classes/_attestedcandidate_.availabilityvote.md index 110e0674c2..06ad7fc7c5 100644 --- a/docs/types/classes/_attestedcandidate_.availabilityvote.md +++ b/docs/types/classes/_attestedcandidate_.availabilityvote.md @@ -25,7 +25,7 @@ *Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [codec/Tuple.ts:20](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L20)* +*Defined in [codec/Tuple.ts:20](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L20)* **Parameters:** @@ -64,7 +64,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L65)* +*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L65)* *__description__*: The types definition of the tuple @@ -79,7 +79,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L56)* +*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -249,7 +249,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L121)* +*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L121)* *__description__*: Filters the array with the callback @@ -669,7 +669,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L130)* +*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L130)* *__description__*: Maps the array with the callback @@ -977,7 +977,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L72)* +*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L72)* *__description__*: Converts the Object to an standard JavaScript Array @@ -994,7 +994,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L79)* +*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L79)* *__description__*: Returns a hex string representation of the value @@ -1011,7 +1011,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L86)* +*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L86)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1045,7 +1045,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L95)* +*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L95)* *__description__*: Returns the string representation of the value @@ -1060,7 +1060,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L104)* +*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L104)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1117,7 +1117,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L43)* +*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L43)* **Type parameters:** diff --git a/docs/types/classes/_attestedcandidate_.balanceupload.md b/docs/types/classes/_attestedcandidate_.balanceupload.md index c93e840978..ff6df8b271 100644 --- a/docs/types/classes/_attestedcandidate_.balanceupload.md +++ b/docs/types/classes/_attestedcandidate_.balanceupload.md @@ -25,7 +25,7 @@ *Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [codec/Tuple.ts:20](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L20)* +*Defined in [codec/Tuple.ts:20](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L20)* **Parameters:** @@ -64,7 +64,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L65)* +*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L65)* *__description__*: The types definition of the tuple @@ -79,7 +79,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L56)* +*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -249,7 +249,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L121)* +*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L121)* *__description__*: Filters the array with the callback @@ -669,7 +669,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L130)* +*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L130)* *__description__*: Maps the array with the callback @@ -977,7 +977,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L72)* +*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L72)* *__description__*: Converts the Object to an standard JavaScript Array @@ -994,7 +994,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L79)* +*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L79)* *__description__*: Returns a hex string representation of the value @@ -1011,7 +1011,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L86)* +*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L86)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1045,7 +1045,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L95)* +*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L95)* *__description__*: Returns the string representation of the value @@ -1060,7 +1060,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L104)* +*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L104)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1117,7 +1117,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L43)* +*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L43)* **Type parameters:** diff --git a/docs/types/classes/_attestedcandidate_.candidatereceipt.md b/docs/types/classes/_attestedcandidate_.candidatereceipt.md index c4d03806a6..37662f623b 100644 --- a/docs/types/classes/_attestedcandidate_.candidatereceipt.md +++ b/docs/types/classes/_attestedcandidate_.candidatereceipt.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [AttestedCandidate.ts:30](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/AttestedCandidate.ts#L30)* +*Defined in [AttestedCandidate.ts:30](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -189,7 +189,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -210,7 +210,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -285,7 +285,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -302,7 +302,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -319,7 +319,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -336,7 +336,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -351,7 +351,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -387,7 +387,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_attestedcandidate_.candidatesignature.md b/docs/types/classes/_attestedcandidate_.candidatesignature.md index 16809e1cd2..95b81e7e8d 100644 --- a/docs/types/classes/_attestedcandidate_.candidatesignature.md +++ b/docs/types/classes/_attestedcandidate_.candidatesignature.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/H512.ts#L14)* +*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/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/e79c6d8/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -134,7 +134,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -165,7 +165,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -691,7 +691,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -715,7 +715,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -732,7 +732,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -766,7 +766,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -781,7 +781,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_attestedcandidate_.egressqueueroot.md b/docs/types/classes/_attestedcandidate_.egressqueueroot.md index c9c9a4edf1..43a3955bbb 100644 --- a/docs/types/classes/_attestedcandidate_.egressqueueroot.md +++ b/docs/types/classes/_attestedcandidate_.egressqueueroot.md @@ -25,7 +25,7 @@ *Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [codec/Tuple.ts:20](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L20)* +*Defined in [codec/Tuple.ts:20](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L20)* **Parameters:** @@ -64,7 +64,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L65)* +*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L65)* *__description__*: The types definition of the tuple @@ -79,7 +79,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L56)* +*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -249,7 +249,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L121)* +*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L121)* *__description__*: Filters the array with the callback @@ -669,7 +669,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L130)* +*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L130)* *__description__*: Maps the array with the callback @@ -977,7 +977,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L72)* +*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L72)* *__description__*: Converts the Object to an standard JavaScript Array @@ -994,7 +994,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L79)* +*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L79)* *__description__*: Returns a hex string representation of the value @@ -1011,7 +1011,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L86)* +*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L86)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1045,7 +1045,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L95)* +*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L95)* *__description__*: Returns the string representation of the value @@ -1060,7 +1060,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L104)* +*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L104)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1117,7 +1117,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L43)* +*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L43)* **Type parameters:** diff --git a/docs/types/classes/_attestedcandidate_.explicitcandidatesignature.md b/docs/types/classes/_attestedcandidate_.explicitcandidatesignature.md index f51ba5750e..fd561088e7 100644 --- a/docs/types/classes/_attestedcandidate_.explicitcandidatesignature.md +++ b/docs/types/classes/_attestedcandidate_.explicitcandidatesignature.md @@ -25,7 +25,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/H512.ts#L14)* +*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/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/e79c6d8/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -130,7 +130,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -161,7 +161,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -687,7 +687,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -711,7 +711,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -728,7 +728,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -762,7 +762,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -777,7 +777,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_attestedcandidate_.headdata.md b/docs/types/classes/_attestedcandidate_.headdata.md index 2c151cd4c6..a48154f508 100644 --- a/docs/types/classes/_attestedcandidate_.headdata.md +++ b/docs/types/classes/_attestedcandidate_.headdata.md @@ -25,7 +25,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bytes.ts#L18)* +*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bytes.ts#L18)* **Parameters:** @@ -115,7 +115,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bytes.ts#L64)* +*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bytes.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -132,7 +132,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -674,7 +674,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -698,7 +698,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -715,7 +715,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -749,7 +749,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -766,7 +766,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bytes.ts#L72)* +*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bytes.ts#L72)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_attestedcandidate_.implicitcandidatesignature.md b/docs/types/classes/_attestedcandidate_.implicitcandidatesignature.md index 761342fd1e..1d1da61b41 100644 --- a/docs/types/classes/_attestedcandidate_.implicitcandidatesignature.md +++ b/docs/types/classes/_attestedcandidate_.implicitcandidatesignature.md @@ -25,7 +25,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/H512.ts#L14)* +*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/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/e79c6d8/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -130,7 +130,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -161,7 +161,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -687,7 +687,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -711,7 +711,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -728,7 +728,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -762,7 +762,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -777,7 +777,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_attestedcandidate_.validityattestation.md b/docs/types/classes/_attestedcandidate_.validityattestation.md index 4164eec15f..8b0564d785 100644 --- a/docs/types/classes/_attestedcandidate_.validityattestation.md +++ b/docs/types/classes/_attestedcandidate_.validityattestation.md @@ -20,7 +20,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [AttestedCandidate.ts:54](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/AttestedCandidate.ts#L54)* +*Defined in [AttestedCandidate.ts:54](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/AttestedCandidate.ts#L54)* **Parameters:** @@ -42,7 +42,7 @@ getencodedLength(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* -*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/EnumType.ts#L97)* +*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/EnumType.ts#L97)* *__description__*: The length of the value when encoded as a Uint8Array @@ -57,7 +57,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/EnumType.ts#L104)* +*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/EnumType.ts#L104)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type @@ -72,7 +72,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/EnumType.ts#L111)* +*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/EnumType.ts#L111)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone) @@ -87,7 +87,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/EnumType.ts#L118)* +*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/EnumType.ts#L118)* *__description__*: The name of the type this enum value represents @@ -102,7 +102,7 @@ getvalue(): [Codec](../interfaces/_types_.codec.md) *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/EnumType.ts#L125)* +*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/EnumType.ts#L125)* *__description__*: The value of the enum @@ -122,7 +122,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/EnumType.ts#L132)* +*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/EnumType.ts#L132)* *__description__*: Returns a hex string representation of the value @@ -139,7 +139,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/EnumType.ts#L139)* +*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/EnumType.ts#L139)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -154,7 +154,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/EnumType.ts#L146)* +*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/EnumType.ts#L146)* *__description__*: Returns the number representation for the value @@ -171,7 +171,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [codec/EnumType.ts:153](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/EnumType.ts#L153)* +*Defined in [codec/EnumType.ts:153](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/EnumType.ts#L153)* *__description__*: Returns the string representation of the value @@ -186,7 +186,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/EnumType.ts#L161)* +*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/EnumType.ts#L161)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_attestedcandidate_.validityvote.md b/docs/types/classes/_attestedcandidate_.validityvote.md index a35164d25b..a1b6a83e72 100644 --- a/docs/types/classes/_attestedcandidate_.validityvote.md +++ b/docs/types/classes/_attestedcandidate_.validityvote.md @@ -25,7 +25,7 @@ *Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [codec/Tuple.ts:20](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L20)* +*Defined in [codec/Tuple.ts:20](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L20)* **Parameters:** @@ -64,7 +64,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L65)* +*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L65)* *__description__*: The types definition of the tuple @@ -79,7 +79,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L56)* +*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -249,7 +249,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L121)* +*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L121)* *__description__*: Filters the array with the callback @@ -669,7 +669,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L130)* +*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L130)* *__description__*: Maps the array with the callback @@ -977,7 +977,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L72)* +*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L72)* *__description__*: Converts the Object to an standard JavaScript Array @@ -994,7 +994,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L79)* +*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L79)* *__description__*: Returns a hex string representation of the value @@ -1011,7 +1011,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L86)* +*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L86)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1045,7 +1045,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L95)* +*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L95)* *__description__*: Returns the string representation of the value @@ -1060,7 +1060,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L104)* +*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L104)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1117,7 +1117,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L43)* +*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L43)* **Type parameters:** diff --git a/docs/types/classes/_authorityid_.authorityid.html b/docs/types/classes/_authorityid_.authorityid.html index 51306bf785..4687b65848 100644 --- a/docs/types/classes/_authorityid_.authorityid.html +++ b/docs/types/classes/_authorityid_.authorityid.html @@ -1976,7 +1976,7 @@

⊕ new AuthorityId(value?: AnyU8a): AuthorityId

Inherited from AccountId.constructor

Overrides U8aFixed.constructor

-

Defined in AccountId.ts:19

+

Defined in AccountId.ts:19

Parameters:

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


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

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


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

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2728,7 +2728,7 @@

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

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

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

Parameters:

@@ -2759,7 +2759,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2769,7 +2769,7 @@

Implementation of Codec.toJSON

Inherited from AccountId.toJSON

Overrides U8a.toJSON

-

Defined in AccountId.ts:46

+

Defined in AccountId.ts:46

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

Returns: any


@@ -2787,7 +2787,7 @@

Implementation of Codec.toString

Inherited from AccountId.toString

Overrides U8a.toString

-

Defined in AccountId.ts:53

+

Defined in AccountId.ts:53

description: Returns the string representation of the value

Returns: string


@@ -2795,7 +2795,7 @@

toU8a

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

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

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

Parameters:

@@ -2828,7 +2828,7 @@

<Static> encode

▸ encode(value: Uint8Array): string

Inherited from AccountId.encode

-

Defined in AccountId.ts:27

+

Defined in AccountId.ts:27

Parameters:

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

⊕ new Balance(value?: AnyNumber): Balance

Inherited from U128.constructor

Overrides UInt.constructor

-

Defined in U128.ts:14

+

Defined in U128.ts:14

Parameters:

@@ -1998,7 +1998,7 @@

encodedLength

getencodedLength(): number

Inherited from AbstractInt.encodedLength

-

Defined in codec/AbstractInt.ts:56

+

Defined in codec/AbstractInt.ts:56

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

Returns: number


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

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

-

Defined in codec/AbstractInt.ts:63

+

Defined in codec/AbstractInt.ts:63

description: Returns the number of bits in the value

Returns: UIntBitLength


@@ -3509,7 +3509,7 @@

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

-

Defined in codec/AbstractInt.ts:70

+

Defined in codec/AbstractInt.ts:70

description: Returns the BN representation of the number. (Compatibility)

Returns: BN


@@ -3546,7 +3546,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -3556,7 +3556,7 @@

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

-

Defined in codec/AbstractInt.ts:82

+

Defined in codec/AbstractInt.ts:82

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

Returns: any


@@ -3596,7 +3596,7 @@

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

-

Defined in codec/AbstractInt.ts:92

+

Defined in codec/AbstractInt.ts:92

description: Returns the string representation of the value

Parameters:

@@ -3645,7 +3645,7 @@

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

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -3862,7 +3862,7 @@

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

-

Defined in codec/AbstractInt.ts:37

+

Defined in codec/AbstractInt.ts:37

Parameters:

@@ -4054,7 +4054,7 @@ diff --git a/docs/types/classes/_balance_.balance.md b/docs/types/classes/_balance_.balance.md index 28a322b25b..7b773ea000 100644 --- a/docs/types/classes/_balance_.balance.md +++ b/docs/types/classes/_balance_.balance.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/U128.ts#L14)* +*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/U128.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -188,7 +188,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1523,7 +1523,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1564,7 +1564,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1583,7 +1583,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1636,7 +1636,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1680,7 +1680,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1884,7 +1884,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_bft_.bftauthoritysignature.html b/docs/types/classes/_bft_.bftauthoritysignature.html index d5b5903186..4147d9ded0 100644 --- a/docs/types/classes/_bft_.bftauthoritysignature.html +++ b/docs/types/classes/_bft_.bftauthoritysignature.html @@ -1978,7 +1978,7 @@

constructor

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

Overrides Tuple.constructor

-

Defined in Bft.ts:20

+

Defined in Bft.ts:20

Parameters:

@@ -2009,14 +2009,14 @@

Types

getTypes(): Array<string>

Inherited from Tuple.Types

-

Defined in codec/Tuple.ts:65

+

Defined in codec/Tuple.ts:65

description: The types definition of the tuple

Returns: Array<string>


authorityId

getauthorityId(): AuthorityId

-

Defined in Bft.ts:31

+

Defined in Bft.ts:31

description: The wrapped [[AuthoriyId]]

Returns: AuthorityId


@@ -2024,14 +2024,14 @@

encodedLength

getencodedLength(): number

Inherited from Tuple.encodedLength

-

Defined in codec/Tuple.ts:56

+

Defined in codec/Tuple.ts:56

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

Returns: number


signature

getsignature(): Signature

-

Defined in Bft.ts:38

+

Defined in Bft.ts:38

description: The wrapped Signature value

Returns: Signature


@@ -2212,7 +2212,7 @@

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

Inherited from Tuple.filter

Overrides Array.filter

-

Defined in codec/Tuple.ts:121

+

Defined in codec/Tuple.ts:121

description: Filters the array with the callback

Parameters:

@@ -2765,7 +2765,7 @@

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

Inherited from Tuple.map

Overrides Array.map

-

Defined in codec/Tuple.ts:130

+

Defined in codec/Tuple.ts:130

description: Maps the array with the callback

Type parameters:

U

@@ -3147,7 +3147,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

-

Defined in codec/Tuple.ts:72

+

Defined in codec/Tuple.ts:72

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -3156,7 +3156,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

-

Defined in codec/Tuple.ts:79

+

Defined in codec/Tuple.ts:79

description: Returns a hex string representation of the value

Returns: string


@@ -3165,7 +3165,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

-

Defined in codec/Tuple.ts:86

+

Defined in codec/Tuple.ts:86

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

Returns: any


@@ -3183,7 +3183,7 @@

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:95

+

Defined in codec/Tuple.ts:95

description: Returns the string representation of the value

Returns: string


@@ -3191,7 +3191,7 @@

toU8a

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

Inherited from Tuple.toU8a

-

Defined in codec/Tuple.ts:104

+

Defined in codec/Tuple.ts:104

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

Parameters:

@@ -3249,7 +3249,7 @@

<Static> with

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

Inherited from Tuple.with

-

Defined in codec/Tuple.ts:43

+

Defined in codec/Tuple.ts:43

Type parameters:

S : Array<Constructor>

Parameters:

@@ -3312,7 +3312,7 @@ diff --git a/docs/types/classes/_bft_.bftauthoritysignature.md b/docs/types/classes/_bft_.bftauthoritysignature.md index 34b84b6922..683d1b1a8e 100644 --- a/docs/types/classes/_bft_.bftauthoritysignature.md +++ b/docs/types/classes/_bft_.bftauthoritysignature.md @@ -29,7 +29,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [Bft.ts:20](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bft.ts#L20)* +*Defined in [Bft.ts:20](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bft.ts#L20)* **Parameters:** @@ -67,7 +67,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L65)* +*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L65)* *__description__*: The types definition of the tuple @@ -80,7 +80,7 @@ ___ getauthorityId(): [AuthorityId](_authorityid_.authorityid.md) -*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bft.ts#L31)* +*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bft.ts#L31)* *__description__*: The wrapped \[\[AuthoriyId\]\] @@ -95,7 +95,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L56)* +*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -108,7 +108,7 @@ ___ getsignature(): [Signature](_signature_.signature.md) -*Defined in [Bft.ts:38](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bft.ts#L38)* +*Defined in [Bft.ts:38](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bft.ts#L38)* *__description__*: The wrapped [Signature](_signature_.signature.md) value @@ -278,7 +278,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L121)* +*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L121)* *__description__*: Filters the array with the callback @@ -698,7 +698,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L130)* +*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L130)* *__description__*: Maps the array with the callback @@ -1006,7 +1006,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L72)* +*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L72)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1023,7 +1023,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L79)* +*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L79)* *__description__*: Returns a hex string representation of the value @@ -1040,7 +1040,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L86)* +*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L86)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1074,7 +1074,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L95)* +*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L95)* *__description__*: Returns the string representation of the value @@ -1089,7 +1089,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L104)* +*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L104)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1146,7 +1146,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L43)* +*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L43)* **Type parameters:** diff --git a/docs/types/classes/_bft_.bfthashsignature.html b/docs/types/classes/_bft_.bfthashsignature.html index d18d21d11d..28ecbc1190 100644 --- a/docs/types/classes/_bft_.bfthashsignature.html +++ b/docs/types/classes/_bft_.bfthashsignature.html @@ -1978,7 +1978,7 @@

constructor

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

Overrides Tuple.constructor

-

Defined in Bft.ts:51

+

Defined in Bft.ts:51

Parameters:

@@ -2009,7 +2009,7 @@

Types

getTypes(): Array<string>

Inherited from Tuple.Types

-

Defined in codec/Tuple.ts:65

+

Defined in codec/Tuple.ts:65

description: The types definition of the tuple

Returns: Array<string>


@@ -2017,21 +2017,21 @@

encodedLength

getencodedLength(): number

Inherited from Tuple.encodedLength

-

Defined in codec/Tuple.ts:56

+

Defined in codec/Tuple.ts:56

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

Returns: number


hash

gethash(): Hash

-

Defined in Bft.ts:62

+

Defined in Bft.ts:62

description: The wrapped Hash

Returns: Hash


signature

getsignature(): Signature

-

Defined in Bft.ts:69

+

Defined in Bft.ts:69

description: The wrapped Signature

Returns: Signature


@@ -2212,7 +2212,7 @@

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

Inherited from Tuple.filter

Overrides Array.filter

-

Defined in codec/Tuple.ts:121

+

Defined in codec/Tuple.ts:121

description: Filters the array with the callback

Parameters:

@@ -2765,7 +2765,7 @@

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

Inherited from Tuple.map

Overrides Array.map

-

Defined in codec/Tuple.ts:130

+

Defined in codec/Tuple.ts:130

description: Maps the array with the callback

Type parameters:

U

@@ -3147,7 +3147,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

-

Defined in codec/Tuple.ts:72

+

Defined in codec/Tuple.ts:72

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -3156,7 +3156,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

-

Defined in codec/Tuple.ts:79

+

Defined in codec/Tuple.ts:79

description: Returns a hex string representation of the value

Returns: string


@@ -3165,7 +3165,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

-

Defined in codec/Tuple.ts:86

+

Defined in codec/Tuple.ts:86

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

Returns: any


@@ -3183,7 +3183,7 @@

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:95

+

Defined in codec/Tuple.ts:95

description: Returns the string representation of the value

Returns: string


@@ -3191,7 +3191,7 @@

toU8a

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

Inherited from Tuple.toU8a

-

Defined in codec/Tuple.ts:104

+

Defined in codec/Tuple.ts:104

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

Parameters:

@@ -3249,7 +3249,7 @@

<Static> with

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

Inherited from Tuple.with

-

Defined in codec/Tuple.ts:43

+

Defined in codec/Tuple.ts:43

Type parameters:

S : Array<Constructor>

Parameters:

@@ -3312,7 +3312,7 @@ diff --git a/docs/types/classes/_bft_.bfthashsignature.md b/docs/types/classes/_bft_.bfthashsignature.md index f8d3f7062f..e37ca6c064 100644 --- a/docs/types/classes/_bft_.bfthashsignature.md +++ b/docs/types/classes/_bft_.bfthashsignature.md @@ -29,7 +29,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [Bft.ts:51](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bft.ts#L51)* +*Defined in [Bft.ts:51](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bft.ts#L51)* **Parameters:** @@ -67,7 +67,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L65)* +*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L65)* *__description__*: The types definition of the tuple @@ -82,7 +82,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L56)* +*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -95,7 +95,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Bft.ts:62](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bft.ts#L62)* +*Defined in [Bft.ts:62](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bft.ts#L62)* *__description__*: The wrapped [Hash](_hash_.hash.md) @@ -108,7 +108,7 @@ ___ getsignature(): [Signature](_signature_.signature.md) -*Defined in [Bft.ts:69](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bft.ts#L69)* +*Defined in [Bft.ts:69](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bft.ts#L69)* *__description__*: The wrapped [Signature](_signature_.signature.md) @@ -278,7 +278,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L121)* +*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L121)* *__description__*: Filters the array with the callback @@ -698,7 +698,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L130)* +*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L130)* *__description__*: Maps the array with the callback @@ -1006,7 +1006,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L72)* +*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L72)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1023,7 +1023,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L79)* +*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L79)* *__description__*: Returns a hex string representation of the value @@ -1040,7 +1040,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L86)* +*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L86)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1074,7 +1074,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L95)* +*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L95)* *__description__*: Returns the string representation of the value @@ -1089,7 +1089,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L104)* +*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L104)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1146,7 +1146,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L43)* +*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L43)* **Type parameters:** diff --git a/docs/types/classes/_block_.block.html b/docs/types/classes/_block_.block.html index 3bde58a14e..0c5883bac7 100644 --- a/docs/types/classes/_block_.block.html +++ b/docs/types/classes/_block_.block.html @@ -1979,7 +1979,7 @@

constructor

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

Overrides Struct.constructor

-

Defined in Block.ts:24

+

Defined in Block.ts:24

Parameters:

@@ -2015,7 +2015,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2023,28 +2023,28 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


extrinsics

getextrinsics(): Extrinsics

-

Defined in Block.ts:35

+

Defined in Block.ts:35

description: The Extrinsics conatined in the block

Returns: Extrinsics


hash

gethash(): Hash

-

Defined in Block.ts:42

+

Defined in Block.ts:42

description: Coinvenience getter, encoded the Hash for the block

Returns: Hash


getheader(): Header

-

Defined in Block.ts:51

+

Defined in Block.ts:51

description: The Header in the block

Returns: Header


@@ -2125,7 +2125,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

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

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

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

Parameters:

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

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


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

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


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

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

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

Returns: any


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

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


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

toU8a

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

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

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

Parameters:

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

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2360,7 +2360,7 @@ diff --git a/docs/types/classes/_block_.block.md b/docs/types/classes/_block_.block.md index 2bf9c7fd92..c0db109671 100644 --- a/docs/types/classes/_block_.block.md +++ b/docs/types/classes/_block_.block.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Block.ts:24](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Block.ts#L24)* +*Defined in [Block.ts:24](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Block.ts#L24)* **Parameters:** @@ -76,7 +76,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -104,7 +104,7 @@ ___ getextrinsics(): [Extrinsics](_extrinsics_.extrinsics.md) -*Defined in [Block.ts:35](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Block.ts#L35)* +*Defined in [Block.ts:35](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Block.ts#L35)* *__description__*: The [Extrinsics](_extrinsics_.extrinsics.md) conatined in the block @@ -117,7 +117,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Block.ts:42](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Block.ts#L42)* +*Defined in [Block.ts:42](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Block.ts#L42)* *__description__*: Coinvenience getter, encoded the [Hash](_hash_.hash.md) for the block @@ -130,7 +130,7 @@ ___ getheader(): [Header](_header_.header.md) -*Defined in [Block.ts:51](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Block.ts#L51)* +*Defined in [Block.ts:51](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Block.ts#L51)* *__description__*: The [Header](_header_.header.md) in the block @@ -232,7 +232,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -253,7 +253,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -328,7 +328,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -345,7 +345,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -362,7 +362,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -379,7 +379,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -430,7 +430,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_blocknumber_.blocknumber.html b/docs/types/classes/_blocknumber_.blocknumber.html index dae66d0383..2aa1edac50 100644 --- a/docs/types/classes/_blocknumber_.blocknumber.html +++ b/docs/types/classes/_blocknumber_.blocknumber.html @@ -1975,7 +1975,7 @@

⊕ new BlockNumber(value?: AnyNumber): BlockNumber

Inherited from U64.constructor

Overrides UInt.constructor

-

Defined in U64.ts:14

+

Defined in U64.ts:14

Parameters:

@@ -1998,7 +1998,7 @@

encodedLength

getencodedLength(): number

Inherited from AbstractInt.encodedLength

-

Defined in codec/AbstractInt.ts:56

+

Defined in codec/AbstractInt.ts:56

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

Returns: number


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

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

-

Defined in codec/AbstractInt.ts:63

+

Defined in codec/AbstractInt.ts:63

description: Returns the number of bits in the value

Returns: UIntBitLength


@@ -3509,7 +3509,7 @@

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

-

Defined in codec/AbstractInt.ts:70

+

Defined in codec/AbstractInt.ts:70

description: Returns the BN representation of the number. (Compatibility)

Returns: BN


@@ -3546,7 +3546,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -3556,7 +3556,7 @@

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

-

Defined in codec/AbstractInt.ts:82

+

Defined in codec/AbstractInt.ts:82

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

Returns: any


@@ -3596,7 +3596,7 @@

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

-

Defined in codec/AbstractInt.ts:92

+

Defined in codec/AbstractInt.ts:92

description: Returns the string representation of the value

Parameters:

@@ -3645,7 +3645,7 @@

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

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -3862,7 +3862,7 @@

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

-

Defined in codec/AbstractInt.ts:37

+

Defined in codec/AbstractInt.ts:37

Parameters:

@@ -4054,7 +4054,7 @@ diff --git a/docs/types/classes/_blocknumber_.blocknumber.md b/docs/types/classes/_blocknumber_.blocknumber.md index faa54d0dab..74159942d3 100644 --- a/docs/types/classes/_blocknumber_.blocknumber.md +++ b/docs/types/classes/_blocknumber_.blocknumber.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/U64.ts#L14)* +*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/U64.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -188,7 +188,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1523,7 +1523,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1564,7 +1564,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1583,7 +1583,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1636,7 +1636,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1680,7 +1680,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1884,7 +1884,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_bool_.bool.html b/docs/types/classes/_bool_.bool.html index a262b871ee..0893b3bd62 100644 --- a/docs/types/classes/_bool_.bool.html +++ b/docs/types/classes/_bool_.bool.html @@ -1973,7 +1973,7 @@

constructor

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

-

Defined in Bool.ts:15

+

Defined in Bool.ts:15

Parameters:

@@ -2003,7 +2003,7 @@

encodedLength

getencodedLength(): number

-

Defined in Bool.ts:35

+

Defined in Bool.ts:35

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

Returns: number


@@ -2012,7 +2012,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in Bool.ts:42

+

Defined in Bool.ts:42

description: Returns a hex string representation of the value

Returns: string


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

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in Bool.ts:49

+

Defined in Bool.ts:49

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

Returns: any


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

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in Bool.ts:56

+

Defined in Bool.ts:56

description: Returns the string representation of the value

Returns: string


toU8a

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

-

Defined in Bool.ts:64

+

Defined in Bool.ts:64

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

Parameters:

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

constructor

⊕ new Bytes(value: AnyU8a): Bytes

Overrides U8a.constructor

-

Defined in Bytes.ts:18

+

Defined in Bytes.ts:18

Parameters:

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

encodedLength

getencodedLength(): number

Overrides U8a.encodedLength

-

Defined in Bytes.ts:64

+

Defined in Bytes.ts:64

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

Returns: number


@@ -2048,7 +2048,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2723,7 +2723,7 @@

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

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

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

Parameters:

@@ -2754,7 +2754,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2763,7 +2763,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

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

Returns: any


@@ -2781,7 +2781,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2789,7 +2789,7 @@

toU8a

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

Overrides U8a.toU8a

-

Defined in Bytes.ts:72

+

Defined in Bytes.ts:72

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

Parameters:

@@ -2861,7 +2861,7 @@ diff --git a/docs/types/classes/_bytes_.bytes.md b/docs/types/classes/_bytes_.bytes.md index 05670e2375..c3d5f7f08d 100644 --- a/docs/types/classes/_bytes_.bytes.md +++ b/docs/types/classes/_bytes_.bytes.md @@ -37,7 +37,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bytes.ts#L18)* +*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bytes.ts#L18)* **Parameters:** @@ -125,7 +125,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bytes.ts#L64)* +*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bytes.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -142,7 +142,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -684,7 +684,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -708,7 +708,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -725,7 +725,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -759,7 +759,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -774,7 +774,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bytes.ts#L72)* +*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bytes.ts#L72)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_chainproperties_.chainproperties.html b/docs/types/classes/_chainproperties_.chainproperties.html index a7d5b05d54..aabb7cec81 100644 --- a/docs/types/classes/_chainproperties_.chainproperties.html +++ b/docs/types/classes/_chainproperties_.chainproperties.html @@ -1973,7 +1973,7 @@

constructor

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

-

Defined in ChainProperties.ts:17

+

Defined in ChainProperties.ts:17

Parameters:

@@ -2001,7 +2001,7 @@

encodedLength

getencodedLength(): number

-

Defined in ChainProperties.ts:29

+

Defined in ChainProperties.ts:29

description: Always 0, never encodes as a Uint8Array

Returns: number


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

get

▸ get(name: string): any | undefined

Overrides Map.get

-

Defined in ChainProperties.ts:37

+

Defined in ChainProperties.ts:37

description: Returns a specific names entry in the structure

Parameters:

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

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in ChainProperties.ts:44

+

Defined in ChainProperties.ts:44

description: Unimplemented, will throw

Returns: string


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

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in ChainProperties.ts:51

+

Defined in ChainProperties.ts:51

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

Returns: any


@@ -2051,14 +2051,14 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in ChainProperties.ts:62

+

Defined in ChainProperties.ts:62

description: Returns the string representation of the value

Returns: string


toU8a

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

-

Defined in ChainProperties.ts:69

+

Defined in ChainProperties.ts:69

description: Unimplemented, will throw

Parameters:

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

constructor

⊕ new Base(value?: any): Base

-

Defined in codec/Base.ts:10

+

Defined in codec/Base.ts:10

Parameters:

@@ -2037,7 +2037,7 @@ diff --git a/docs/types/classes/_codec_base_.base.md b/docs/types/classes/_codec_base_.base.md index 4805d97d19..db1b864634 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/e79c6d8/packages/types/src/codec/Base.ts#L10)* +*Defined in [codec/Base.ts:10](https://github.com/polkadot-js/api/blob/e802b8e/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 b4b015ae03..5b3ade67f6 100644 --- a/docs/types/classes/_codec_compact_.compact.html +++ b/docs/types/classes/_codec_compact_.compact.html @@ -1974,7 +1974,7 @@

constructor

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

Overrides Base.constructor

-

Defined in codec/Compact.ts:23

+

Defined in codec/Compact.ts:23

Parameters:

@@ -2003,25 +2003,25 @@

<Static> addLengthPrefix

● addLengthPrefix: compactAddLength = compactAddLength

-

Defined in codec/Compact.ts:41

+

Defined in codec/Compact.ts:41

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


<Static> decodeU8a

● decodeU8a: compactFromU8a = compactFromU8a

-

Defined in codec/Compact.ts:42

+

Defined in codec/Compact.ts:42


<Static> encodeU8a

● encodeU8a: compactToU8a = compactToU8a

-

Defined in codec/Compact.ts:43

+

Defined in codec/Compact.ts:43


Accessors

encodedLength

getencodedLength(): number

-

Defined in codec/Compact.ts:70

+

Defined in codec/Compact.ts:70

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

Returns: number


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

bitLength

▸ bitLength(): UIntBitLength

-

Defined in codec/Compact.ts:77

+

Defined in codec/Compact.ts:77

description: Returns the number of bits in the value

Returns: UIntBitLength


toBn

▸ toBn(): BN

-

Defined in codec/Compact.ts:84

+

Defined in codec/Compact.ts:84

description: Returns the BN representation of the number

Returns: BN


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

toHex

▸ toHex(): any

Implementation of Codec.toHex

-

Defined in codec/Compact.ts:91

+

Defined in codec/Compact.ts:91

description: Returns a hex string representation of the value

Returns: any


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

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Compact.ts:98

+

Defined in codec/Compact.ts:98

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

Returns: any


toNumber

▸ toNumber(): number

-

Defined in codec/Compact.ts:105

+

Defined in codec/Compact.ts:105

description: Returns the number representation for the value

Returns: number


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

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/Compact.ts:112

+

Defined in codec/Compact.ts:112

description: Returns the string representation of the value

Returns: string


toU8a

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

-

Defined in codec/Compact.ts:120

+

Defined in codec/Compact.ts:120

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

Parameters:

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

<Static> decodeCompact

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

-

Defined in codec/Compact.ts:51

+

Defined in codec/Compact.ts:51

Parameters:

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

<Static> stripLengthPrefix

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

-

Defined in codec/Compact.ts:45

+

Defined in codec/Compact.ts:45

Parameters:

@@ -2151,7 +2151,7 @@

<Static> with

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

-

Defined in codec/Compact.ts:28

+

Defined in codec/Compact.ts:28

Parameters:

@@ -2212,7 +2212,7 @@ diff --git a/docs/types/classes/_codec_compact_.compact.md b/docs/types/classes/_codec_compact_.compact.md index 32a5a71609..96ea233ca8 100644 --- a/docs/types/classes/_codec_compact_.compact.md +++ b/docs/types/classes/_codec_compact_.compact.md @@ -24,7 +24,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/e79c6d8/packages/types/src/codec/Compact.ts#L23)* +*Defined in [codec/Compact.ts:23](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Compact.ts#L23)* **Parameters:** @@ -45,7 +45,7 @@ ___ **● addLengthPrefix**: *`compactAddLength`* = compactAddLength -*Defined in [codec/Compact.ts:41](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Compact.ts#L41)* +*Defined in [codec/Compact.ts:41](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Compact.ts#L41)* Prepend a Uint8Array with its compact length. *__param__*: The Uint8Array to be prefixed @@ -57,7 +57,7 @@ ___ **● decodeU8a**: *`compactFromU8a`* = compactFromU8a -*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Compact.ts#L42)* +*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Compact.ts#L42)* ___ @@ -66,7 +66,7 @@ ___ **● encodeU8a**: *`compactToU8a`* = compactToU8a -*Defined in [codec/Compact.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Compact.ts#L43)* +*Defined in [codec/Compact.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Compact.ts#L43)* ___ @@ -78,7 +78,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Compact.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Compact.ts#L70)* +*Defined in [codec/Compact.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Compact.ts#L70)* *__description__*: The length of the value when encoded as a Uint8Array @@ -94,7 +94,7 @@ ___ ▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) -*Defined in [codec/Compact.ts:77](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Compact.ts#L77)* +*Defined in [codec/Compact.ts:77](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Compact.ts#L77)* *__description__*: Returns the number of bits in the value @@ -107,7 +107,7 @@ ___ ▸ **toBn**(): `BN` -*Defined in [codec/Compact.ts:84](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Compact.ts#L84)* +*Defined in [codec/Compact.ts:84](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Compact.ts#L84)* *__description__*: Returns the BN representation of the number @@ -122,7 +122,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Compact.ts:91](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Compact.ts#L91)* +*Defined in [codec/Compact.ts:91](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Compact.ts#L91)* *__description__*: Returns a hex string representation of the value @@ -137,7 +137,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Compact.ts:98](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Compact.ts#L98)* +*Defined in [codec/Compact.ts:98](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Compact.ts#L98)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -150,7 +150,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [codec/Compact.ts:105](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Compact.ts#L105)* +*Defined in [codec/Compact.ts:105](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Compact.ts#L105)* *__description__*: Returns the number representation for the value @@ -165,7 +165,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [codec/Compact.ts:112](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Compact.ts#L112)* +*Defined in [codec/Compact.ts:112](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Compact.ts#L112)* *__description__*: Returns the string representation of the value @@ -178,7 +178,7 @@ ___ ▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` -*Defined in [codec/Compact.ts:120](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Compact.ts#L120)* +*Defined in [codec/Compact.ts:120](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Compact.ts#L120)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -197,7 +197,7 @@ ___ ▸ **decodeCompact**(Type: *[Constructor](../modules/_types_.md#constructor)< [UInt](_codec_uint_.uint.md) | [Moment](_moment_.moment.md)>*, value: *[AnyNumber](../modules/_types_.md#anynumber)*): [Moment](_moment_.moment.md) | [UInt](_codec_uint_.uint.md) -*Defined in [codec/Compact.ts:51](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Compact.ts#L51)* +*Defined in [codec/Compact.ts:51](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Compact.ts#L51)* **Parameters:** @@ -215,7 +215,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/e79c6d8/packages/types/src/codec/Compact.ts#L45)* +*Defined in [codec/Compact.ts:45](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Compact.ts#L45)* **Parameters:** @@ -233,7 +233,7 @@ ___ ▸ **with**(Type: *[Constructor](../modules/_types_.md#constructor)< [UInt](_codec_uint_.uint.md) | [Moment](_moment_.moment.md)>*): [Constructor](../modules/_types_.md#constructor)<[Compact](_codec_compact_.compact.md)> -*Defined in [codec/Compact.ts:28](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Compact.ts#L28)* +*Defined in [codec/Compact.ts:28](https://github.com/polkadot-js/api/blob/e802b8e/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 892299fed3..9dc048324d 100644 --- a/docs/types/classes/_codec_enum_.enum.html +++ b/docs/types/classes/_codec_enum_.enum.html @@ -1977,7 +1977,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:

@@ -2006,7 +2006,7 @@

encodedLength

getencodedLength(): number

-

Defined in codec/Enum.ts:64

+

Defined in codec/Enum.ts:64

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

Returns: number


@@ -2015,7 +2015,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Enum.ts:71

+

Defined in codec/Enum.ts:71

description: Returns a hex string representation of the value

Returns: string


@@ -2023,14 +2023,14 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Enum.ts:78

+

Defined in codec/Enum.ts:78

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

Returns: any


toNumber

▸ toNumber(): number

-

Defined in codec/Enum.ts:85

+

Defined in codec/Enum.ts:85

description: Returns the number representation for the value

Returns: number


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

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/Enum.ts:92

+

Defined in codec/Enum.ts:92

description: Returns the string representation of the value

Returns: string


toU8a

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

-

Defined in codec/Enum.ts:100

+

Defined in codec/Enum.ts:100

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

Parameters:

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

@@ -2134,7 +2134,7 @@ diff --git a/docs/types/classes/_codec_enum_.enum.md b/docs/types/classes/_codec_enum_.enum.md index 73ea7d16ea..d68924cb00 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/e79c6d8/packages/types/src/codec/Enum.ts#L29)* +*Defined in [codec/Enum.ts:29](https://github.com/polkadot-js/api/blob/e802b8e/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/e79c6d8/packages/types/src/codec/Enum.ts#L64)* +*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -69,7 +69,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L71)* +*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L71)* *__description__*: Returns a hex string representation of the value @@ -84,7 +84,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L78)* +*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L78)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -97,7 +97,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [codec/Enum.ts:85](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L85)* +*Defined in [codec/Enum.ts:85](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L85)* *__description__*: Returns the number representation for the value @@ -112,7 +112,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [codec/Enum.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L92)* +*Defined in [codec/Enum.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L92)* *__description__*: Returns the string representation of the value @@ -125,7 +125,7 @@ ___ ▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` -*Defined in [codec/Enum.ts:100](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L100)* +*Defined in [codec/Enum.ts:100](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L100)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -144,7 +144,7 @@ ___ ▸ **decodeEnum**(def: *`EnumDef`*, value: * [Enum](_codec_enum_.enum.md) | `Uint8Array` | `string` | `number`*): `number` | `undefined` -*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L47)* +*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/e802b8e/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 d9aae89771..c75733d203 100644 --- a/docs/types/classes/_codec_enumtype_.enumtype.html +++ b/docs/types/classes/_codec_enumtype_.enumtype.html @@ -1982,7 +1982,7 @@

constructor

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

Overrides Base.constructor

-

Defined in codec/EnumType.ts:32

+

Defined in codec/EnumType.ts:32

Parameters:

@@ -2012,35 +2012,35 @@

encodedLength

getencodedLength(): number

-

Defined in codec/EnumType.ts:97

+

Defined in codec/EnumType.ts:97

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

Returns: number


isNone

getisNone(): boolean

-

Defined in codec/EnumType.ts:104

+

Defined in codec/EnumType.ts:104

description: Checks if the Enum points to a Null type

Returns: boolean


isNull

getisNull(): boolean

-

Defined in codec/EnumType.ts:111

+

Defined in codec/EnumType.ts:111

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

Returns: boolean


type

gettype(): string

-

Defined in codec/EnumType.ts:118

+

Defined in codec/EnumType.ts:118

description: The name of the type this enum value represents

Returns: string


value

getvalue(): Codec

-

Defined in codec/EnumType.ts:125

+

Defined in codec/EnumType.ts:125

description: The value of the enum

Returns: Codec


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

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/EnumType.ts:132

+

Defined in codec/EnumType.ts:132

description: Returns a hex string representation of the value

Returns: string


@@ -2057,14 +2057,14 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/EnumType.ts:139

+

Defined in codec/EnumType.ts:139

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

Returns: any


toNumber

▸ toNumber(): number

-

Defined in codec/EnumType.ts:146

+

Defined in codec/EnumType.ts:146

description: Returns the number representation for the value

Returns: number


@@ -2072,14 +2072,14 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/EnumType.ts:153

+

Defined in codec/EnumType.ts:153

description: Returns the string representation of the value

Returns: string


toU8a

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

-

Defined in codec/EnumType.ts:161

+

Defined in codec/EnumType.ts:161

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

Parameters:

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

@@ -2002,28 +2002,28 @@

encodedLength

getencodedLength(): number

-

Defined in codec/Option.ts:52

+

Defined in codec/Option.ts:52

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

Returns: number


isNone

getisNone(): boolean

-

Defined in codec/Option.ts:60

+

Defined in codec/Option.ts:60

description: Checks if the Option has no value

Returns: boolean


isSome

getisSome(): boolean

-

Defined in codec/Option.ts:67

+

Defined in codec/Option.ts:67

description: Checks if the Option has a value

Returns: boolean


value

getvalue(): Codec

-

Defined in codec/Option.ts:74

+

Defined in codec/Option.ts:74

description: The actual value for the Option

Returns: Codec


@@ -2032,7 +2032,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Option.ts:81

+

Defined in codec/Option.ts:81

description: Returns a hex string representation of the value

Returns: string


@@ -2040,7 +2040,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Option.ts:88

+

Defined in codec/Option.ts:88

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

Returns: any


@@ -2048,14 +2048,14 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/Option.ts:95

+

Defined in codec/Option.ts:95

description: Returns the string representation of the value

Returns: string


toU8a

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

-

Defined in codec/Option.ts:103

+

Defined in codec/Option.ts:103

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

Parameters:

@@ -2079,14 +2079,14 @@

unwrap

▸ unwrap(): T

-

Defined in codec/Option.ts:121

+

Defined in codec/Option.ts:121

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

Returns: T


<Static> decodeOption

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

-

Defined in codec/Option.ts:26

+

Defined in codec/Option.ts:26

Type parameters:

O

Parameters:

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

<Static> with

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

-

Defined in codec/Option.ts:41

+

Defined in codec/Option.ts:41

Type parameters:

O : Codec

Parameters:

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

constructor

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

Overrides Base.constructor

-

Defined in codec/Set.ts:22

+

Defined in codec/Set.ts:22

Parameters:

@@ -2000,28 +2000,28 @@

encodedLength

getencodedLength(): number

-

Defined in codec/Set.ts:72

+

Defined in codec/Set.ts:72

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

Returns: number


isEmpty

getisEmpty(): boolean

-

Defined in codec/Set.ts:79

+

Defined in codec/Set.ts:79

description: true is the Set contains no values

Returns: boolean


valueEncoded

getvalueEncoded(): number

-

Defined in codec/Set.ts:93

+

Defined in codec/Set.ts:93

description: The encoded value for the set members

Returns: number


values

getvalues(): Array<string>

-

Defined in codec/Set.ts:86

+

Defined in codec/Set.ts:86

description: The actual set values as a Array

Returns: Array<string>


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

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Set.ts:100

+

Defined in codec/Set.ts:100

description: Returns a hex string representation of the value

Returns: string


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

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Set.ts:107

+

Defined in codec/Set.ts:107

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

Returns: any


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

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/Set.ts:114

+

Defined in codec/Set.ts:114

description: Returns the string representation of the value

Returns: string


toU8a

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

-

Defined in codec/Set.ts:122

+

Defined in codec/Set.ts:122

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

Parameters:

@@ -2077,7 +2077,7 @@

<Static> decodeSet

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

-

Defined in codec/Set.ts:32

+

Defined in codec/Set.ts:32

Parameters:

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

<Static> encodeSet

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

-

Defined in codec/Set.ts:63

+

Defined in codec/Set.ts:63

Parameters:

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

@@ -2053,14 +2053,14 @@

Type

getType(): E

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


encodedLength

getencodedLength(): number

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


@@ -2069,7 +2069,7 @@

get

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

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

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

getAtIndex

▸ getAtIndex(index: number): Codec

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

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

Parameters:

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

toArray

▸ toArray(): Array<Codec>

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


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

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


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

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

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

Returns: any


@@ -2139,14 +2139,14 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


toU8a

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

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

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

Parameters:

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

<Static> with

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

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2233,7 +2233,7 @@ diff --git a/docs/types/classes/_codec_struct_.struct.md b/docs/types/classes/_codec_struct_.struct.md index f389785061..89ca37f8f4 100644 --- a/docs/types/classes/_codec_struct_.struct.md +++ b/docs/types/classes/_codec_struct_.struct.md @@ -97,7 +97,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/e79c6d8/packages/types/src/codec/Struct.ts#L31)* +*Defined in [codec/Struct.ts:31](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L31)* **Parameters:** @@ -131,7 +131,7 @@ ___ getType(): `E` -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -144,7 +144,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -162,7 +162,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -181,7 +181,7 @@ ___ ▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -200,7 +200,7 @@ ___ ▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -215,7 +215,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -230,7 +230,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -245,7 +245,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -258,7 +258,7 @@ ___ ▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -277,7 +277,7 @@ ___ ▸ **with**<`S`>(Types: *`S`*): [Constructor](../modules/_types_.md#constructor)<[Struct](_codec_struct_.struct.md)<`S`>> -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_codec_tuple_.tuple.html b/docs/types/classes/_codec_tuple_.tuple.html index 09bfa80e9b..f184ca8553 100644 --- a/docs/types/classes/_codec_tuple_.tuple.html +++ b/docs/types/classes/_codec_tuple_.tuple.html @@ -1990,7 +1990,7 @@

constructor

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

-

Defined in codec/Tuple.ts:20

+

Defined in codec/Tuple.ts:20

Parameters:

@@ -2022,14 +2022,14 @@

Types

getTypes(): Array<string>

-

Defined in codec/Tuple.ts:65

+

Defined in codec/Tuple.ts:65

description: The types definition of the tuple

Returns: Array<string>


encodedLength

getencodedLength(): number

-

Defined in codec/Tuple.ts:56

+

Defined in codec/Tuple.ts:56

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

Returns: number


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

filter

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

Overrides Array.filter

-

Defined in codec/Tuple.ts:121

+

Defined in codec/Tuple.ts:121

description: Filters the array with the callback

Parameters:

@@ -2068,7 +2068,7 @@

map

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

Overrides Array.map

-

Defined in codec/Tuple.ts:130

+

Defined in codec/Tuple.ts:130

description: Maps the array with the callback

Type parameters:

U

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

toArray

▸ toArray(): Array<Codec>

-

Defined in codec/Tuple.ts:72

+

Defined in codec/Tuple.ts:72

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


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

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Tuple.ts:79

+

Defined in codec/Tuple.ts:79

description: Returns a hex string representation of the value

Returns: string


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

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Tuple.ts:86

+

Defined in codec/Tuple.ts:86

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

Returns: any


@@ -2124,14 +2124,14 @@

▸ toString(): string

Implementation of Codec.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:95

+

Defined in codec/Tuple.ts:95

description: Returns the string representation of the value

Returns: string


toU8a

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

-

Defined in codec/Tuple.ts:104

+

Defined in codec/Tuple.ts:104

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

Parameters:

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

<Static> with

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

-

Defined in codec/Tuple.ts:43

+

Defined in codec/Tuple.ts:43

Type parameters:

S : Array<Constructor>

Parameters:

@@ -2218,7 +2218,7 @@ diff --git a/docs/types/classes/_codec_tuple_.tuple.md b/docs/types/classes/_codec_tuple_.tuple.md index 9998bfa0d7..ba2027ef17 100644 --- a/docs/types/classes/_codec_tuple_.tuple.md +++ b/docs/types/classes/_codec_tuple_.tuple.md @@ -53,7 +53,7 @@ ⊕ **new Tuple**(Types: *`S`*, value: *`any`*): [Tuple](_codec_tuple_.tuple.md) -*Defined in [codec/Tuple.ts:20](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L20)* +*Defined in [codec/Tuple.ts:20](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L20)* **Parameters:** @@ -86,7 +86,7 @@ ___ getTypes(): `Array`<`string`> -*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L65)* +*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L65)* *__description__*: The types definition of the tuple @@ -99,7 +99,7 @@ ___ getencodedLength(): `number` -*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L56)* +*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -117,7 +117,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L121)* +*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L121)* *__description__*: Filters the array with the callback @@ -139,7 +139,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L130)* +*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L130)* *__description__*: Maps the array with the callback @@ -162,7 +162,7 @@ ___ ▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> -*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L72)* +*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L72)* *__description__*: Converts the Object to an standard JavaScript Array @@ -177,7 +177,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L79)* +*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L79)* *__description__*: Returns a hex string representation of the value @@ -192,7 +192,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L86)* +*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L86)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -209,7 +209,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L95)* +*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L95)* *__description__*: Returns the string representation of the value @@ -222,7 +222,7 @@ ___ ▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` -*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L104)* +*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L104)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -241,7 +241,7 @@ ___ ▸ **with**<`S`>(Types: *`S`*): [Constructor](../modules/_types_.md#constructor)<[Tuple](_codec_tuple_.tuple.md)<`S`>> -*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L43)* +*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L43)* **Type parameters:** diff --git a/docs/types/classes/_codec_typeregistry_.typeregistry.html b/docs/types/classes/_codec_typeregistry_.typeregistry.html index 3bd61a4ae9..a4350ddb3a 100644 --- a/docs/types/classes/_codec_typeregistry_.typeregistry.html +++ b/docs/types/classes/_codec_typeregistry_.typeregistry.html @@ -1966,13 +1966,13 @@

<Static> defaultRegistry

● defaultRegistry: TypeRegistry = new TypeRegistry()

-

Defined in codec/typeRegistry.ts:16

+

Defined in codec/typeRegistry.ts:16


Methods

get

▸ get(name: string): Constructor | undefined

-

Defined in codec/typeRegistry.ts:51

+

Defined in codec/typeRegistry.ts:51

Parameters:

@@ -1994,7 +1994,7 @@

register

▸ register(type: Constructor | ConstructorObj): void

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

-

Defined in codec/typeRegistry.ts:20

+

Defined in codec/typeRegistry.ts:20

Parameters:

@@ -2011,7 +2011,7 @@

Returns: void

-

Defined in codec/typeRegistry.ts:21

+

Defined in codec/typeRegistry.ts:21

Parameters:

@@ -2076,7 +2076,7 @@ diff --git a/docs/types/classes/_codec_typeregistry_.typeregistry.md b/docs/types/classes/_codec_typeregistry_.typeregistry.md index c4e8e2d81d..cf9d4aa688 100644 --- a/docs/types/classes/_codec_typeregistry_.typeregistry.md +++ b/docs/types/classes/_codec_typeregistry_.typeregistry.md @@ -12,7 +12,7 @@ **● defaultRegistry**: *[TypeRegistry](_codec_typeregistry_.typeregistry.md)* = new TypeRegistry() -*Defined in [codec/typeRegistry.ts:16](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/typeRegistry.ts#L16)* +*Defined in [codec/typeRegistry.ts:16](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/typeRegistry.ts#L16)* ___ @@ -24,7 +24,7 @@ ___ ▸ **get**(name: *`string`*): [Constructor](../modules/_types_.md#constructor) | `undefined` -*Defined in [codec/typeRegistry.ts:51](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/typeRegistry.ts#L51)* +*Defined in [codec/typeRegistry.ts:51](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/typeRegistry.ts#L51)* **Parameters:** @@ -43,7 +43,7 @@ ___ ▸ **register**(name: *`string`*, type: *[Constructor](../modules/_types_.md#constructor)*): `void` -*Defined in [codec/typeRegistry.ts:20](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/typeRegistry.ts#L20)* +*Defined in [codec/typeRegistry.ts:20](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/typeRegistry.ts#L20)* **Parameters:** @@ -53,7 +53,7 @@ ___ **Returns:** `void` -*Defined in [codec/typeRegistry.ts:21](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/typeRegistry.ts#L21)* +*Defined in [codec/typeRegistry.ts:21](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/typeRegistry.ts#L21)* **Parameters:** diff --git a/docs/types/classes/_codec_u8a_.u8a.html b/docs/types/classes/_codec_u8a_.u8a.html index e589021555..ad24849e20 100644 --- a/docs/types/classes/_codec_u8a_.u8a.html +++ b/docs/types/classes/_codec_u8a_.u8a.html @@ -1979,7 +1979,7 @@

constructor

⊕ new U8a(value: AnyU8a): U8a

-

Defined in codec/U8a.ts:18

+

Defined in codec/U8a.ts:18

Parameters:

@@ -2007,7 +2007,7 @@

encodedLength

getencodedLength(): number

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

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

Returns: number


@@ -2015,7 +2015,7 @@

length

getlength(): number

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2024,7 +2024,7 @@

subarray

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

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

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

Parameters:

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

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


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

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

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

Returns: any


@@ -2071,14 +2071,14 @@

▸ toString(): string

Implementation of Codec.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


toU8a

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

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

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

Parameters:

@@ -2142,7 +2142,7 @@ diff --git a/docs/types/classes/_codec_u8a_.u8a.md b/docs/types/classes/_codec_u8a_.u8a.md index 2e112a15f3..ef567b5076 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/e79c6d8/packages/types/src/codec/U8a.ts#L18)* +*Defined in [codec/U8a.ts:18](https://github.com/polkadot-js/api/blob/e802b8e/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/e79c6d8/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -80,7 +80,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -98,7 +98,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -120,7 +120,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -135,7 +135,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -152,7 +152,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -165,7 +165,7 @@ ___ ▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_codec_u8afixed_.u8afixed.html b/docs/types/classes/_codec_u8afixed_.u8afixed.html index 8cc70dcfa5..1b3a4c7398 100644 --- a/docs/types/classes/_codec_u8afixed_.u8afixed.html +++ b/docs/types/classes/_codec_u8afixed_.u8afixed.html @@ -1982,7 +1982,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:

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


@@ -2056,7 +2056,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2071,7 +2071,7 @@

bitLength

▸ bitLength(): number

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2738,7 +2738,7 @@

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

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

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

Parameters:

@@ -2769,7 +2769,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2778,7 +2778,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

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

Returns: any


@@ -2796,7 +2796,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2804,7 +2804,7 @@

toU8a

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

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

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

Parameters:

@@ -2876,7 +2876,7 @@ diff --git a/docs/types/classes/_codec_u8afixed_.u8afixed.md b/docs/types/classes/_codec_u8afixed_.u8afixed.md index 44d3232f73..a58938cf14 100644 --- a/docs/types/classes/_codec_u8afixed_.u8afixed.md +++ b/docs/types/classes/_codec_u8afixed_.u8afixed.md @@ -39,7 +39,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [codec/U8aFixed.ts:19](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8aFixed.ts#L19)* +*Defined in [codec/U8aFixed.ts:19](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8aFixed.ts#L19)* **Parameters:** @@ -128,7 +128,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/e79c6d8/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -145,7 +145,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -174,7 +174,7 @@ ___ ▸ **bitLength**(): `number` -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -700,7 +700,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -724,7 +724,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -741,7 +741,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -775,7 +775,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -790,7 +790,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_codec_uint_.uint.html b/docs/types/classes/_codec_uint_.uint.html index 8096f9f44f..b8c33a8dba 100644 --- a/docs/types/classes/_codec_uint_.uint.html +++ b/docs/types/classes/_codec_uint_.uint.html @@ -1980,7 +1980,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:

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


@@ -2024,7 +2024,7 @@

toU8a

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

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -2088,7 +2088,7 @@ diff --git a/docs/types/classes/_codec_uint_.uint.md b/docs/types/classes/_codec_uint_.uint.md index e442c60a2e..1537136338 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/e79c6d8/packages/types/src/codec/UInt.ts#L21)* +*Defined in [codec/UInt.ts:21](https://github.com/polkadot-js/api/blob/e802b8e/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/e79c6d8/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -77,7 +77,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/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 5ca1c4ef0b..e30a91d48b 100644 --- a/docs/types/classes/_codec_vector_.vector.html +++ b/docs/types/classes/_codec_vector_.vector.html @@ -1980,7 +1980,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:

@@ -2015,13 +2015,13 @@

Type

getType(): string

-

Defined in codec/Vector.ts:57

+

Defined in codec/Vector.ts:57

Returns: string


encodedLength

getencodedLength(): number

-

Defined in codec/Vector.ts:64

+

Defined in codec/Vector.ts:64

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

Returns: number


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

length

getlength(): number

Overrides Array.length

-

Defined in codec/Vector.ts:73

+

Defined in codec/Vector.ts:73

description: The length of the value

Returns: number


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

filter

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

Overrides Array.filter

-

Defined in codec/Vector.ts:139

+

Defined in codec/Vector.ts:139

description: Filters the array with the callback

Parameters:

@@ -2068,7 +2068,7 @@

map

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

Overrides Array.map

-

Defined in codec/Vector.ts:148

+

Defined in codec/Vector.ts:148

description: Maps the array with the callback

Type parameters:

U

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

toArray

▸ toArray(): Array<T>

-

Defined in codec/Vector.ts:81

+

Defined in codec/Vector.ts:81

description: Converts the Object to an standard JavaScript Array

Returns: Array<T>


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

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in codec/Vector.ts:88

+

Defined in codec/Vector.ts:88

description: Returns a hex string representation of the value

Returns: string


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

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in codec/Vector.ts:95

+

Defined in codec/Vector.ts:95

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

Returns: any


@@ -2124,14 +2124,14 @@

▸ toString(): string

Implementation of Codec.toString

Overrides Array.toString

-

Defined in codec/Vector.ts:104

+

Defined in codec/Vector.ts:104

description: Returns the string representation of the value

Returns: string


toU8a

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

-

Defined in codec/Vector.ts:117

+

Defined in codec/Vector.ts:117

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

Parameters:

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

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

<Static> with

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

-

Defined in codec/Vector.ts:49

+

Defined in codec/Vector.ts:49

Type parameters:

O : Codec

Parameters:

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

constructor

⊕ new Data(value: AnyU8a): Data

Inherited from U8a.constructor

-

Defined in codec/U8a.ts:18

+

Defined in codec/U8a.ts:18

Parameters:

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


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

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2718,7 +2718,7 @@

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

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

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

Parameters:

@@ -2749,7 +2749,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2758,7 +2758,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

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

Returns: any


@@ -2776,7 +2776,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2784,7 +2784,7 @@

toU8a

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

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

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

Parameters:

@@ -2856,7 +2856,7 @@ diff --git a/docs/types/classes/_data_.data.md b/docs/types/classes/_data_.data.md index ee2f7da861..4fd3bca40b 100644 --- a/docs/types/classes/_data_.data.md +++ b/docs/types/classes/_data_.data.md @@ -27,7 +27,7 @@ *Inherited from [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [codec/U8a.ts:18](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L18)* +*Defined in [codec/U8a.ts:18](https://github.com/polkadot-js/api/blob/e802b8e/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/e79c6d8/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -132,7 +132,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -674,7 +674,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -698,7 +698,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -715,7 +715,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -749,7 +749,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -764,7 +764,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_digest_.authoritieschange.html b/docs/types/classes/_digest_.authoritieschange.html index 16cb5ccab1..a76cfc1f07 100644 --- a/docs/types/classes/_digest_.authoritieschange.html +++ b/docs/types/classes/_digest_.authoritieschange.html @@ -1978,7 +1978,7 @@

constructor

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

Inherited from Vector.constructor

-

Defined in codec/Vector.ts:22

+

Defined in codec/Vector.ts:22

Parameters:

@@ -2008,14 +2008,14 @@

Type

getType(): string

Inherited from Vector.Type

-

Defined in codec/Vector.ts:57

+

Defined in codec/Vector.ts:57

Returns: string


encodedLength

getencodedLength(): number

Inherited from Vector.encodedLength

-

Defined in codec/Vector.ts:64

+

Defined in codec/Vector.ts:64

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

Returns: number


@@ -2024,7 +2024,7 @@

getlength(): number

Inherited from Vector.length

Overrides Array.length

-

Defined in codec/Vector.ts:73

+

Defined in codec/Vector.ts:73

description: The length of the value

Returns: number


@@ -2205,7 +2205,7 @@

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

Inherited from Vector.filter

Overrides Array.filter

-

Defined in codec/Vector.ts:139

+

Defined in codec/Vector.ts:139

description: Filters the array with the callback

Parameters:

@@ -2758,7 +2758,7 @@

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

Inherited from Vector.map

Overrides Array.map

-

Defined in codec/Vector.ts:148

+

Defined in codec/Vector.ts:148

description: Maps the array with the callback

Type parameters:

U

@@ -3140,7 +3140,7 @@

toArray

▸ toArray(): Array<T>

Inherited from Vector.toArray

-

Defined in codec/Vector.ts:81

+

Defined in codec/Vector.ts:81

description: Converts the Object to an standard JavaScript Array

Returns: Array<T>


@@ -3149,7 +3149,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Vector.toHex

-

Defined in codec/Vector.ts:88

+

Defined in codec/Vector.ts:88

description: Returns a hex string representation of the value

Returns: string


@@ -3158,7 +3158,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Vector.toJSON

-

Defined in codec/Vector.ts:95

+

Defined in codec/Vector.ts:95

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

Returns: any


@@ -3176,7 +3176,7 @@

Implementation of Codec.toString

Inherited from Vector.toString

Overrides Array.toString

-

Defined in codec/Vector.ts:104

+

Defined in codec/Vector.ts:104

description: Returns the string representation of the value

Returns: string


@@ -3184,7 +3184,7 @@

toU8a

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

Inherited from Vector.toU8a

-

Defined in codec/Vector.ts:117

+

Defined in codec/Vector.ts:117

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

Parameters:

@@ -3242,7 +3242,7 @@

<Static> decodeVector

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

Inherited from Vector.decodeVector

-

Defined in codec/Vector.ts:32

+

Defined in codec/Vector.ts:32

Type parameters:

T : Codec

Parameters:

@@ -3270,7 +3270,7 @@

<Static> with

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

Inherited from Vector.with

-

Defined in codec/Vector.ts:49

+

Defined in codec/Vector.ts:49

Type parameters:

O : Codec

Parameters:

@@ -3333,7 +3333,7 @@ diff --git a/docs/types/classes/_digest_.authoritieschange.md b/docs/types/classes/_digest_.authoritieschange.md index 78ceb2c24e..8be7f78ade 100644 --- a/docs/types/classes/_digest_.authoritieschange.md +++ b/docs/types/classes/_digest_.authoritieschange.md @@ -29,7 +29,7 @@ *Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)* -*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L22)* +*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L22)* **Parameters:** @@ -52,7 +52,7 @@ getType(): `string` *Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* -*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L57)* +*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L57)* **Returns:** `string` @@ -65,7 +65,7 @@ getencodedLength(): `number` *Inherited from [Vector](_codec_vector_.vector.md).[encodedLength](_codec_vector_.vector.md#encodedlength)* -*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L64)* +*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -82,7 +82,7 @@ getlength(): `number` *Overrides Array.length* -*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L73)* +*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L73)* *__description__*: The length of the value @@ -252,7 +252,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L139)* +*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L139)* *__description__*: Filters the array with the callback @@ -672,7 +672,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L148)* +*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L148)* *__description__*: Maps the array with the callback @@ -980,7 +980,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)* -*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L81)* +*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L81)* *__description__*: Converts the Object to an standard JavaScript Array @@ -997,7 +997,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)* -*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L88)* +*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L88)* *__description__*: Returns a hex string representation of the value @@ -1014,7 +1014,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* -*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L95)* +*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L95)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1048,7 +1048,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L104)* +*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L104)* *__description__*: Returns the string representation of the value @@ -1063,7 +1063,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* -*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L117)* +*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L117)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1120,7 +1120,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/e79c6d8/packages/types/src/codec/Vector.ts#L32)* +*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L32)* **Type parameters:** @@ -1143,7 +1143,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* -*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L49)* +*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L49)* **Type parameters:** diff --git a/docs/types/classes/_digest_.changestrieroot.html b/docs/types/classes/_digest_.changestrieroot.html index 4d1ead69f1..249600a113 100644 --- a/docs/types/classes/_digest_.changestrieroot.html +++ b/docs/types/classes/_digest_.changestrieroot.html @@ -1977,7 +1977,7 @@

⊕ new ChangesTrieRoot(value?: AnyU8a): ChangesTrieRoot

Inherited from H256.constructor

Overrides U8aFixed.constructor

-

Defined in H256.ts:15

+

Defined in H256.ts:15

Parameters:

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


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

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


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

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2727,7 +2727,7 @@

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

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

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

Parameters:

@@ -2758,7 +2758,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2767,7 +2767,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

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

Returns: any


@@ -2785,7 +2785,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2793,7 +2793,7 @@

toU8a

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

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

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

Parameters:

@@ -2865,7 +2865,7 @@ diff --git a/docs/types/classes/_digest_.changestrieroot.md b/docs/types/classes/_digest_.changestrieroot.md index b69141b225..96d1136661 100644 --- a/docs/types/classes/_digest_.changestrieroot.md +++ b/docs/types/classes/_digest_.changestrieroot.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/H256.ts#L15)* +*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/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/e79c6d8/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -134,7 +134,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -165,7 +165,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -691,7 +691,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -715,7 +715,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -732,7 +732,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -766,7 +766,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -781,7 +781,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_digest_.digest.html b/docs/types/classes/_digest_.digest.html index 0fdd2da97e..9676600e1a 100644 --- a/docs/types/classes/_digest_.digest.html +++ b/docs/types/classes/_digest_.digest.html @@ -1979,7 +1979,7 @@

constructor

⊕ new Digest(value: any): Digest

Overrides Struct.constructor

-

Defined in Digest.ts:89

+

Defined in Digest.ts:89

Parameters:

@@ -2015,7 +2015,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2023,14 +2023,14 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


logs

getlogs(): Vector<DigestItem>

-

Defined in Digest.ts:99

+

Defined in Digest.ts:99

description: The DigestItem logs

Returns: Vector<DigestItem>


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

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

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

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

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

Parameters:

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

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


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

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2233,7 +2233,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

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

Returns: any


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

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2250,7 +2250,7 @@

toU8a

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

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

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

Parameters:

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

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2346,7 +2346,7 @@ diff --git a/docs/types/classes/_digest_.digest.md b/docs/types/classes/_digest_.digest.md index 425f9b8acd..fef6e23d5c 100644 --- a/docs/types/classes/_digest_.digest.md +++ b/docs/types/classes/_digest_.digest.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Digest.ts:89](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Digest.ts#L89)* +*Defined in [Digest.ts:89](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Digest.ts#L89)* **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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -104,7 +104,7 @@ ___ getlogs(): [Vector](_codec_vector_.vector.md)<[DigestItem](_digest_.digestitem.md)> -*Defined in [Digest.ts:99](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Digest.ts#L99)* +*Defined in [Digest.ts:99](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Digest.ts#L99)* *__description__*: The [DigestItem](_digest_.digestitem.md) logs @@ -206,7 +206,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -227,7 +227,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -302,7 +302,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -319,7 +319,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -336,7 +336,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -353,7 +353,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -368,7 +368,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -404,7 +404,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_digest_.digestitem.html b/docs/types/classes/_digest_.digestitem.html index 74ac37e469..4324cf5fda 100644 --- a/docs/types/classes/_digest_.digestitem.html +++ b/docs/types/classes/_digest_.digestitem.html @@ -1974,7 +1974,7 @@

constructor

⊕ new DigestItem(value: any): DigestItem

Overrides EnumType.constructor

-

Defined in Digest.ts:73

+

Defined in Digest.ts:73

Parameters:

@@ -1997,7 +1997,7 @@

encodedLength

getencodedLength(): number

Inherited from EnumType.encodedLength

-

Defined in codec/EnumType.ts:97

+

Defined in codec/EnumType.ts:97

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

Returns: number


@@ -2005,7 +2005,7 @@

isNone

getisNone(): boolean

Inherited from EnumType.isNone

-

Defined in codec/EnumType.ts:104

+

Defined in codec/EnumType.ts:104

description: Checks if the Enum points to a Null type

Returns: boolean


@@ -2013,7 +2013,7 @@

isNull

getisNull(): boolean

Inherited from EnumType.isNull

-

Defined in codec/EnumType.ts:111

+

Defined in codec/EnumType.ts:111

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

Returns: boolean


@@ -2021,7 +2021,7 @@

type

gettype(): string

Inherited from EnumType.type

-

Defined in codec/EnumType.ts:118

+

Defined in codec/EnumType.ts:118

description: The name of the type this enum value represents

Returns: string


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

value

getvalue(): Codec

Inherited from EnumType.value

-

Defined in codec/EnumType.ts:125

+

Defined in codec/EnumType.ts:125

description: The value of the enum

Returns: Codec


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

▸ toHex(): string

Implementation of Codec.toHex

Inherited from EnumType.toHex

-

Defined in codec/EnumType.ts:132

+

Defined in codec/EnumType.ts:132

description: Returns a hex string representation of the value

Returns: string


@@ -2048,7 +2048,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from EnumType.toJSON

-

Defined in codec/EnumType.ts:139

+

Defined in codec/EnumType.ts:139

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

Returns: any


@@ -2056,7 +2056,7 @@

toNumber

▸ toNumber(): number

Inherited from EnumType.toNumber

-

Defined in codec/EnumType.ts:146

+

Defined in codec/EnumType.ts:146

description: Returns the number representation for the value

Returns: number


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

▸ toString(): string

Implementation of Codec.toString

Inherited from EnumType.toString

-

Defined in codec/EnumType.ts:153

+

Defined in codec/EnumType.ts:153

description: Returns the string representation of the value

Returns: string


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

toU8a

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

Inherited from EnumType.toU8a

-

Defined in codec/EnumType.ts:161

+

Defined in codec/EnumType.ts:161

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

Parameters:

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

⊕ new Other(value: AnyU8a): Other

Inherited from Bytes.constructor

Overrides U8a.constructor

-

Defined in Bytes.ts:18

+

Defined in Bytes.ts:18

Parameters:

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

getencodedLength(): number

Inherited from Bytes.encodedLength

Overrides U8a.encodedLength

-

Defined in Bytes.ts:64

+

Defined in Bytes.ts:64

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

Returns: number


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

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2720,7 +2720,7 @@

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

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

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

Parameters:

@@ -2751,7 +2751,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2760,7 +2760,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

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

Returns: any


@@ -2778,7 +2778,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2787,7 +2787,7 @@

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

Inherited from Bytes.toU8a

Overrides U8a.toU8a

-

Defined in Bytes.ts:72

+

Defined in Bytes.ts:72

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

Parameters:

@@ -2859,7 +2859,7 @@ diff --git a/docs/types/classes/_digest_.other.md b/docs/types/classes/_digest_.other.md index 4a3090f3e5..da5ab23fc7 100644 --- a/docs/types/classes/_digest_.other.md +++ b/docs/types/classes/_digest_.other.md @@ -29,7 +29,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bytes.ts#L18)* +*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bytes.ts#L18)* **Parameters:** @@ -119,7 +119,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bytes.ts#L64)* +*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bytes.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -136,7 +136,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -678,7 +678,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -702,7 +702,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -719,7 +719,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -753,7 +753,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -770,7 +770,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bytes.ts#L72)* +*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bytes.ts#L72)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_digest_.seal.html b/docs/types/classes/_digest_.seal.html index cbc66d5b87..cae83abb6d 100644 --- a/docs/types/classes/_digest_.seal.html +++ b/docs/types/classes/_digest_.seal.html @@ -1978,7 +1978,7 @@

constructor

⊕ new Seal(value: any): Seal

Overrides Tuple.constructor

-

Defined in Digest.ts:44

+

Defined in Digest.ts:44

Parameters:

@@ -2009,7 +2009,7 @@

Types

getTypes(): Array<string>

Inherited from Tuple.Types

-

Defined in codec/Tuple.ts:65

+

Defined in codec/Tuple.ts:65

description: The types definition of the tuple

Returns: Array<string>


@@ -2017,21 +2017,21 @@

encodedLength

getencodedLength(): number

Inherited from Tuple.encodedLength

-

Defined in codec/Tuple.ts:56

+

Defined in codec/Tuple.ts:56

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

Returns: number


signature

getsignature(): Signature

-

Defined in Digest.ts:55

+

Defined in Digest.ts:55

description: The wrapped Signature

Returns: Signature


slot

getslot(): U64

-

Defined in Digest.ts:62

+

Defined in Digest.ts:62

description: The wrapped U64 slot

Returns: U64


@@ -2212,7 +2212,7 @@

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

Inherited from Tuple.filter

Overrides Array.filter

-

Defined in codec/Tuple.ts:121

+

Defined in codec/Tuple.ts:121

description: Filters the array with the callback

Parameters:

@@ -2765,7 +2765,7 @@

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

Inherited from Tuple.map

Overrides Array.map

-

Defined in codec/Tuple.ts:130

+

Defined in codec/Tuple.ts:130

description: Maps the array with the callback

Type parameters:

U

@@ -3147,7 +3147,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

-

Defined in codec/Tuple.ts:72

+

Defined in codec/Tuple.ts:72

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -3156,7 +3156,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

-

Defined in codec/Tuple.ts:79

+

Defined in codec/Tuple.ts:79

description: Returns a hex string representation of the value

Returns: string


@@ -3165,7 +3165,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

-

Defined in codec/Tuple.ts:86

+

Defined in codec/Tuple.ts:86

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

Returns: any


@@ -3183,7 +3183,7 @@

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:95

+

Defined in codec/Tuple.ts:95

description: Returns the string representation of the value

Returns: string


@@ -3191,7 +3191,7 @@

toU8a

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

Inherited from Tuple.toU8a

-

Defined in codec/Tuple.ts:104

+

Defined in codec/Tuple.ts:104

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

Parameters:

@@ -3249,7 +3249,7 @@

<Static> with

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

Inherited from Tuple.with

-

Defined in codec/Tuple.ts:43

+

Defined in codec/Tuple.ts:43

Type parameters:

S : Array<Constructor>

Parameters:

@@ -3312,7 +3312,7 @@ diff --git a/docs/types/classes/_digest_.seal.md b/docs/types/classes/_digest_.seal.md index 12f96b1656..053600af87 100644 --- a/docs/types/classes/_digest_.seal.md +++ b/docs/types/classes/_digest_.seal.md @@ -29,7 +29,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [Digest.ts:44](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Digest.ts#L44)* +*Defined in [Digest.ts:44](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Digest.ts#L44)* **Parameters:** @@ -67,7 +67,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L65)* +*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L65)* *__description__*: The types definition of the tuple @@ -82,7 +82,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L56)* +*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -95,7 +95,7 @@ ___ getsignature(): [Signature](_signature_.signature.md) -*Defined in [Digest.ts:55](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Digest.ts#L55)* +*Defined in [Digest.ts:55](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Digest.ts#L55)* *__description__*: The wrapped [Signature](_signature_.signature.md) @@ -108,7 +108,7 @@ ___ getslot(): [U64](_u64_.u64.md) -*Defined in [Digest.ts:62](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Digest.ts#L62)* +*Defined in [Digest.ts:62](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Digest.ts#L62)* *__description__*: The wrapped [U64](_u64_.u64.md) slot @@ -278,7 +278,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L121)* +*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L121)* *__description__*: Filters the array with the callback @@ -698,7 +698,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L130)* +*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L130)* *__description__*: Maps the array with the callback @@ -1006,7 +1006,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L72)* +*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L72)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1023,7 +1023,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L79)* +*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L79)* *__description__*: Returns a hex string representation of the value @@ -1040,7 +1040,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L86)* +*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L86)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1074,7 +1074,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L95)* +*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L95)* *__description__*: Returns the string representation of the value @@ -1089,7 +1089,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L104)* +*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L104)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1146,7 +1146,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L43)* +*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L43)* **Type parameters:** diff --git a/docs/types/classes/_event_.event.html b/docs/types/classes/_event_.event.html index ecdd18b794..24110d1ae3 100644 --- a/docs/types/classes/_event_.event.html +++ b/docs/types/classes/_event_.event.html @@ -1979,7 +1979,7 @@

constructor

⊕ new Event(value: Uint8Array): [Event](_event.event.md)

Overrides Struct.constructor

-

Defined in Event.ts:85

+

Defined in Event.ts:85

Parameters:

@@ -2015,14 +2015,14 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


data

getdata(): EventData

-

Defined in Event.ts:138

+

Defined in Event.ts:138

description: The wrapped EventData

Returns: EventData


@@ -2030,42 +2030,42 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


index

getindex(): EventIndex

-

Defined in Event.ts:145

+

Defined in Event.ts:145

description: The EventIndex, identifying the raw event

Returns: EventIndex


meta

getmeta(): EventMetadata

-

Defined in Event.ts:152

+

Defined in Event.ts:152

description: The EventMetadata with the documentation

Returns: EventMetadata


method

getmethod(): string

-

Defined in Event.ts:159

+

Defined in Event.ts:159

description: The method string identifying the event

Returns: string


section

getsection(): string

-

Defined in Event.ts:166

+

Defined in Event.ts:166

description: The section string identifying the event

Returns: string


typeDef

gettypeDef(): Array<TypeDef>

-

Defined in Event.ts:173

+

Defined in Event.ts:173

description: The TypeDef for the event

Returns: Array<TypeDef>


@@ -2146,7 +2146,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

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

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

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

Parameters:

@@ -2250,7 +2250,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2259,7 +2259,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


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

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

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

Returns: any


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

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


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

toU8a

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

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

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

Parameters:

@@ -2317,7 +2317,7 @@

<Static> decodeEvent

▸ decodeEvent(value: Uint8Array): object

-

Defined in Event.ts:97

+

Defined in Event.ts:97

Parameters:

@@ -2338,7 +2338,7 @@

<Static> injectMetadata

▸ injectMetadata(metadata: Metadata): void

-

Defined in Event.ts:116

+

Defined in Event.ts:116

Parameters:

@@ -2360,7 +2360,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2423,7 +2423,7 @@ diff --git a/docs/types/classes/_event_.event.md b/docs/types/classes/_event_.event.md index 51dfeb459c..466d7cfd19 100644 --- a/docs/types/classes/_event_.event.md +++ b/docs/types/classes/_event_.event.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Event.ts:85](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Event.ts#L85)* +*Defined in [Event.ts:85](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Event.ts#L85)* **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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -89,7 +89,7 @@ ___ getdata(): [EventData](_event_.eventdata.md) -*Defined in [Event.ts:138](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Event.ts#L138)* +*Defined in [Event.ts:138](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Event.ts#L138)* *__description__*: The wrapped [EventData](_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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -117,7 +117,7 @@ ___ getindex(): [EventIndex](_event_.eventindex.md) -*Defined in [Event.ts:145](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Event.ts#L145)* +*Defined in [Event.ts:145](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Event.ts#L145)* *__description__*: The [EventIndex](_event_.eventindex.md), identifying the raw event @@ -130,7 +130,7 @@ ___ getmeta(): [EventMetadata](_metadata_events_.eventmetadata.md) -*Defined in [Event.ts:152](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Event.ts#L152)* +*Defined in [Event.ts:152](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Event.ts#L152)* *__description__*: The [EventMetadata](_metadata_events_.eventmetadata.md) with the documentation @@ -143,7 +143,7 @@ ___ getmethod(): `string` -*Defined in [Event.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Event.ts#L159)* +*Defined in [Event.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Event.ts#L159)* *__description__*: The method string identifying the event @@ -156,7 +156,7 @@ ___ getsection(): `string` -*Defined in [Event.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Event.ts#L166)* +*Defined in [Event.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Event.ts#L166)* *__description__*: The section string identifying the event @@ -169,7 +169,7 @@ ___ gettypeDef(): `Array`<[TypeDef](../modules/_types_.md#typedef)> -*Defined in [Event.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Event.ts#L173)* +*Defined in [Event.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Event.ts#L173)* *__description__*: The [TypeDef](../modules/_types_.md#typedef) for the event @@ -271,7 +271,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__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:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -367,7 +367,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -384,7 +384,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -401,7 +401,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -418,7 +418,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -433,7 +433,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -467,7 +467,7 @@ ___ ▸ **decodeEvent**(value: *`Uint8Array`*): `object` -*Defined in [Event.ts:97](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Event.ts#L97)* +*Defined in [Event.ts:97](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Event.ts#L97)* **Parameters:** @@ -484,7 +484,7 @@ ___ ▸ **injectMetadata**(metadata: *[Metadata](_metadata_index_.metadata.md)*): `void` -*Defined in [Event.ts:116](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Event.ts#L116)* +*Defined in [Event.ts:116](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Event.ts#L116)* **Parameters:** @@ -503,7 +503,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_event_.eventdata.html b/docs/types/classes/_event_.eventdata.html index c2f73b6ce3..340b7c518f 100644 --- a/docs/types/classes/_event_.eventdata.html +++ b/docs/types/classes/_event_.eventdata.html @@ -1978,7 +1978,7 @@

constructor

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

Overrides Tuple.constructor

-

Defined in Event.ts:27

+

Defined in Event.ts:27

Parameters:

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

Types

getTypes(): Array<string>

Inherited from Tuple.Types

-

Defined in codec/Tuple.ts:65

+

Defined in codec/Tuple.ts:65

description: The types definition of the tuple

Returns: Array<string>


@@ -2037,35 +2037,35 @@

encodedLength

getencodedLength(): number

Inherited from Tuple.encodedLength

-

Defined in codec/Tuple.ts:56

+

Defined in codec/Tuple.ts:56

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

Returns: number


meta

getmeta(): EventMetadata

-

Defined in Event.ts:41

+

Defined in Event.ts:41

description: The wrapped EventMetadata

Returns: EventMetadata


method

getmethod(): string

-

Defined in Event.ts:48

+

Defined in Event.ts:48

description: The method as a string

Returns: string


section

getsection(): string

-

Defined in Event.ts:55

+

Defined in Event.ts:55

description: The section as a string

Returns: string


typeDef

gettypeDef(): Array<TypeDef>

-

Defined in Event.ts:62

+

Defined in Event.ts:62

description: The TypeDef for this event

Returns: Array<TypeDef>


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

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

Inherited from Tuple.filter

Overrides Array.filter

-

Defined in codec/Tuple.ts:121

+

Defined in codec/Tuple.ts:121

description: Filters the array with the callback

Parameters:

@@ -2799,7 +2799,7 @@

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

Inherited from Tuple.map

Overrides Array.map

-

Defined in codec/Tuple.ts:130

+

Defined in codec/Tuple.ts:130

description: Maps the array with the callback

Type parameters:

U

@@ -3181,7 +3181,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

-

Defined in codec/Tuple.ts:72

+

Defined in codec/Tuple.ts:72

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -3190,7 +3190,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

-

Defined in codec/Tuple.ts:79

+

Defined in codec/Tuple.ts:79

description: Returns a hex string representation of the value

Returns: string


@@ -3199,7 +3199,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

-

Defined in codec/Tuple.ts:86

+

Defined in codec/Tuple.ts:86

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

Returns: any


@@ -3217,7 +3217,7 @@

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:95

+

Defined in codec/Tuple.ts:95

description: Returns the string representation of the value

Returns: string


@@ -3225,7 +3225,7 @@

toU8a

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

Inherited from Tuple.toU8a

-

Defined in codec/Tuple.ts:104

+

Defined in codec/Tuple.ts:104

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

Parameters:

@@ -3283,7 +3283,7 @@

<Static> with

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

Inherited from Tuple.with

-

Defined in codec/Tuple.ts:43

+

Defined in codec/Tuple.ts:43

Type parameters:

S : Array<Constructor>

Parameters:

@@ -3346,7 +3346,7 @@ diff --git a/docs/types/classes/_event_.eventdata.md b/docs/types/classes/_event_.eventdata.md index 2f96043edc..406ec2f311 100644 --- a/docs/types/classes/_event_.eventdata.md +++ b/docs/types/classes/_event_.eventdata.md @@ -29,7 +29,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [Event.ts:27](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Event.ts#L27)* +*Defined in [Event.ts:27](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Event.ts#L27)* **Parameters:** @@ -72,7 +72,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L65)* +*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L65)* *__description__*: The types definition of the tuple @@ -87,7 +87,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L56)* +*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -100,7 +100,7 @@ ___ getmeta(): [EventMetadata](_metadata_events_.eventmetadata.md) -*Defined in [Event.ts:41](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Event.ts#L41)* +*Defined in [Event.ts:41](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Event.ts#L41)* *__description__*: The wrapped [EventMetadata](_metadata_events_.eventmetadata.md) @@ -113,7 +113,7 @@ ___ getmethod(): `string` -*Defined in [Event.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Event.ts#L48)* +*Defined in [Event.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Event.ts#L48)* *__description__*: The method as a string @@ -126,7 +126,7 @@ ___ getsection(): `string` -*Defined in [Event.ts:55](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Event.ts#L55)* +*Defined in [Event.ts:55](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Event.ts#L55)* *__description__*: The section as a string @@ -139,7 +139,7 @@ ___ gettypeDef(): `Array`<[TypeDef](../modules/_types_.md#typedef)> -*Defined in [Event.ts:62](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Event.ts#L62)* +*Defined in [Event.ts:62](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Event.ts#L62)* *__description__*: The [TypeDef](../modules/_types_.md#typedef) for this event @@ -309,7 +309,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L121)* +*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L121)* *__description__*: Filters the array with the callback @@ -729,7 +729,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L130)* +*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L130)* *__description__*: Maps the array with the callback @@ -1037,7 +1037,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L72)* +*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L72)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1054,7 +1054,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L79)* +*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L79)* *__description__*: Returns a hex string representation of the value @@ -1071,7 +1071,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L86)* +*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L86)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1105,7 +1105,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L95)* +*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L95)* *__description__*: Returns the string representation of the value @@ -1120,7 +1120,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L104)* +*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L104)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1177,7 +1177,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L43)* +*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L43)* **Type parameters:** diff --git a/docs/types/classes/_event_.eventindex.html b/docs/types/classes/_event_.eventindex.html index f27e1ed80e..fbdbf1d884 100644 --- a/docs/types/classes/_event_.eventindex.html +++ b/docs/types/classes/_event_.eventindex.html @@ -1976,7 +1976,7 @@

constructor

⊕ new EventIndex(value?: any): EventIndex

Overrides U8aFixed.constructor

-

Defined in Event.ts:73

+

Defined in Event.ts:73

Parameters:

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


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

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2059,7 +2059,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2726,7 +2726,7 @@

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

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

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

Parameters:

@@ -2757,7 +2757,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2766,7 +2766,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

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

Returns: any


@@ -2784,7 +2784,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2792,7 +2792,7 @@

toU8a

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

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

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

Parameters:

@@ -2864,7 +2864,7 @@ diff --git a/docs/types/classes/_event_.eventindex.md b/docs/types/classes/_event_.eventindex.md index 95cc7d2be4..d049eb8d67 100644 --- a/docs/types/classes/_event_.eventindex.md +++ b/docs/types/classes/_event_.eventindex.md @@ -27,7 +27,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [Event.ts:73](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Event.ts#L73)* +*Defined in [Event.ts:73](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Event.ts#L73)* **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/e79c6d8/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -132,7 +132,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -163,7 +163,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -689,7 +689,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -713,7 +713,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -730,7 +730,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -764,7 +764,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -779,7 +779,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_eventrecord_.applyextrinsic.html b/docs/types/classes/_eventrecord_.applyextrinsic.html index 82939da0ab..41d8696f2a 100644 --- a/docs/types/classes/_eventrecord_.applyextrinsic.html +++ b/docs/types/classes/_eventrecord_.applyextrinsic.html @@ -1975,7 +1975,7 @@

⊕ new ApplyExtrinsic(value?: AnyNumber): ApplyExtrinsic

Inherited from U32.constructor

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -1998,7 +1998,7 @@

encodedLength

getencodedLength(): number

Inherited from AbstractInt.encodedLength

-

Defined in codec/AbstractInt.ts:56

+

Defined in codec/AbstractInt.ts:56

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

Returns: number


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

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

-

Defined in codec/AbstractInt.ts:63

+

Defined in codec/AbstractInt.ts:63

description: Returns the number of bits in the value

Returns: UIntBitLength


@@ -3509,7 +3509,7 @@

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

-

Defined in codec/AbstractInt.ts:70

+

Defined in codec/AbstractInt.ts:70

description: Returns the BN representation of the number. (Compatibility)

Returns: BN


@@ -3546,7 +3546,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -3556,7 +3556,7 @@

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

-

Defined in codec/AbstractInt.ts:82

+

Defined in codec/AbstractInt.ts:82

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

Returns: any


@@ -3596,7 +3596,7 @@

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

-

Defined in codec/AbstractInt.ts:92

+

Defined in codec/AbstractInt.ts:92

description: Returns the string representation of the value

Parameters:

@@ -3645,7 +3645,7 @@

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

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -3862,7 +3862,7 @@

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

-

Defined in codec/AbstractInt.ts:37

+

Defined in codec/AbstractInt.ts:37

Parameters:

@@ -4054,7 +4054,7 @@ diff --git a/docs/types/classes/_eventrecord_.applyextrinsic.md b/docs/types/classes/_eventrecord_.applyextrinsic.md index 5137767159..601e0e8348 100644 --- a/docs/types/classes/_eventrecord_.applyextrinsic.md +++ b/docs/types/classes/_eventrecord_.applyextrinsic.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/U32.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -188,7 +188,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1523,7 +1523,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1564,7 +1564,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1583,7 +1583,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1636,7 +1636,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1680,7 +1680,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1884,7 +1884,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_eventrecord_.eventrecord.html b/docs/types/classes/_eventrecord_.eventrecord.html index f706fd823d..80e2c79dab 100644 --- a/docs/types/classes/_eventrecord_.eventrecord.html +++ b/docs/types/classes/_eventrecord_.eventrecord.html @@ -1979,7 +1979,7 @@

constructor

⊕ new EventRecord(value: any): EventRecord

Overrides Struct.constructor

-

Defined in EventRecord.ts:47

+

Defined in EventRecord.ts:47

Parameters:

@@ -2015,7 +2015,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2023,21 +2023,21 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


event

getevent(): Event

-

Defined in EventRecord.ts:58

+

Defined in EventRecord.ts:58

description: The Event this record refers to

Returns: Event


phase

getphase(): Phase

-

Defined in EventRecord.ts:65

+

Defined in EventRecord.ts:65

description: The Phase where the event was generated

Returns: Phase


@@ -2118,7 +2118,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

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

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

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

Parameters:

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

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


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

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


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

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

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

Returns: any


@@ -2249,7 +2249,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2257,7 +2257,7 @@

toU8a

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

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

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

Parameters:

@@ -2290,7 +2290,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2353,7 +2353,7 @@ diff --git a/docs/types/classes/_eventrecord_.eventrecord.md b/docs/types/classes/_eventrecord_.eventrecord.md index 791899fb5e..e7f2e103ec 100644 --- a/docs/types/classes/_eventrecord_.eventrecord.md +++ b/docs/types/classes/_eventrecord_.eventrecord.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [EventRecord.ts:47](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/EventRecord.ts#L47)* +*Defined in [EventRecord.ts:47](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/EventRecord.ts#L47)* **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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -104,7 +104,7 @@ ___ getevent(): [Event](_event_.event.md) -*Defined in [EventRecord.ts:58](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/EventRecord.ts#L58)* +*Defined in [EventRecord.ts:58](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/EventRecord.ts#L58)* *__description__*: The [Event](_event_.event.md) this record refers to @@ -117,7 +117,7 @@ ___ getphase(): [Phase](_eventrecord_.phase.md) -*Defined in [EventRecord.ts:65](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/EventRecord.ts#L65)* +*Defined in [EventRecord.ts:65](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/EventRecord.ts#L65)* *__description__*: The [Phase](_eventrecord_.phase.md) where the event was generated @@ -219,7 +219,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -240,7 +240,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -315,7 +315,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -332,7 +332,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -381,7 +381,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -417,7 +417,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_eventrecord_.finalization.html b/docs/types/classes/_eventrecord_.finalization.html index ed0677c60a..11cbc79bec 100644 --- a/docs/types/classes/_eventrecord_.finalization.html +++ b/docs/types/classes/_eventrecord_.finalization.html @@ -1974,7 +1974,7 @@

encodedLength

getencodedLength(): number

Inherited from Null.encodedLength

-

Defined in Null.ts:16

+

Defined in Null.ts:16

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

Returns: number


@@ -1984,7 +1984,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Null.toHex

-

Defined in Null.ts:23

+

Defined in Null.ts:23

description: Returns a hex string representation of the value

Returns: string


@@ -1993,7 +1993,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Null.toJSON

-

Defined in Null.ts:30

+

Defined in Null.ts:30

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

Returns: any


@@ -2002,7 +2002,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Null.toString

-

Defined in Null.ts:37

+

Defined in Null.ts:37

description: Returns the string representation of the value

Returns: string


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

toU8a

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

Inherited from Null.toU8a

-

Defined in Null.ts:45

+

Defined in Null.ts:45

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

Parameters:

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

constructor

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

Overrides EnumType.constructor

-

Defined in EventRecord.ts:32

+

Defined in EventRecord.ts:32

Parameters:

@@ -2001,7 +2001,7 @@

encodedLength

getencodedLength(): number

Inherited from EnumType.encodedLength

-

Defined in codec/EnumType.ts:97

+

Defined in codec/EnumType.ts:97

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

Returns: number


@@ -2009,7 +2009,7 @@

isNone

getisNone(): boolean

Inherited from EnumType.isNone

-

Defined in codec/EnumType.ts:104

+

Defined in codec/EnumType.ts:104

description: Checks if the Enum points to a Null type

Returns: boolean


@@ -2017,7 +2017,7 @@

isNull

getisNull(): boolean

Inherited from EnumType.isNull

-

Defined in codec/EnumType.ts:111

+

Defined in codec/EnumType.ts:111

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

Returns: boolean


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

type

gettype(): string

Inherited from EnumType.type

-

Defined in codec/EnumType.ts:118

+

Defined in codec/EnumType.ts:118

description: The name of the type this enum value represents

Returns: string


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

value

getvalue(): Codec

Inherited from EnumType.value

-

Defined in codec/EnumType.ts:125

+

Defined in codec/EnumType.ts:125

description: The value of the enum

Returns: Codec


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

▸ toHex(): string

Implementation of Codec.toHex

Inherited from EnumType.toHex

-

Defined in codec/EnumType.ts:132

+

Defined in codec/EnumType.ts:132

description: Returns a hex string representation of the value

Returns: string


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

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from EnumType.toJSON

-

Defined in codec/EnumType.ts:139

+

Defined in codec/EnumType.ts:139

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

Returns: any


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

toNumber

▸ toNumber(): number

Inherited from EnumType.toNumber

-

Defined in codec/EnumType.ts:146

+

Defined in codec/EnumType.ts:146

description: Returns the number representation for the value

Returns: number


@@ -2069,7 +2069,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from EnumType.toString

-

Defined in codec/EnumType.ts:153

+

Defined in codec/EnumType.ts:153

description: Returns the string representation of the value

Returns: string


@@ -2077,7 +2077,7 @@

toU8a

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

Inherited from EnumType.toU8a

-

Defined in codec/EnumType.ts:161

+

Defined in codec/EnumType.ts:161

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

Parameters:

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

constructor

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

Overrides Struct.constructor

-

Defined in Extrinsic.ts:36

+

Defined in Extrinsic.ts:36

Parameters:

@@ -2021,28 +2021,28 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


args

getargs(): Array<Codec>

-

Defined in Extrinsic.ts:71

+

Defined in Extrinsic.ts:71

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

Returns: Array<Codec>


callIndex

getcallIndex(): Uint8Array

-

Defined in Extrinsic.ts:78

+

Defined in Extrinsic.ts:78

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

Returns: Uint8Array


data

getdata(): Uint8Array

-

Defined in Extrinsic.ts:85

+

Defined in Extrinsic.ts:85

description: The actual data for the Method

Returns: Uint8Array


@@ -2050,49 +2050,49 @@

encodedLength

getencodedLength(): number

Overrides Struct.encodedLength

-

Defined in Extrinsic.ts:92

+

Defined in Extrinsic.ts:92

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

Returns: number


hash

gethash(): Hash

-

Defined in Extrinsic.ts:101

+

Defined in Extrinsic.ts:101

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

Returns: Hash


isSigned

getisSigned(): boolean

-

Defined in Extrinsic.ts:110

+

Defined in Extrinsic.ts:110

description: true id the extrinsic is signed

Returns: boolean


length

getlength(): number

-

Defined in Extrinsic.ts:117

+

Defined in Extrinsic.ts:117

description: The length of the encoded value

Returns: number


meta

getmeta(): FunctionMetadata

-

Defined in Extrinsic.ts:124

+

Defined in Extrinsic.ts:124

description: The FunctionMetadata that describes the extrinsic

Returns: FunctionMetadata


method

getmethod(): Method

-

Defined in Extrinsic.ts:131

+

Defined in Extrinsic.ts:131

description: The Method this extrinsic wraps

Returns: Method


signature

getsignature(): ExtrinsicSignature

-

Defined in Extrinsic.ts:138

+

Defined in Extrinsic.ts:138

description: The ExtrinsicSignature

Returns: ExtrinsicSignature


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

addSignature

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

-

Defined in Extrinsic.ts:145

+

Defined in Extrinsic.ts:145

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

Parameters:

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

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2232,7 +2232,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

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

Parameters:

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

sign

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

-

Defined in Extrinsic.ts:154

+

Defined in Extrinsic.ts:154

description: Sign the extrinsic with a specific keypair

Parameters:

@@ -2345,7 +2345,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2354,7 +2354,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Overrides Struct.toHex

-

Defined in Extrinsic.ts:163

+

Defined in Extrinsic.ts:163

description: Returns a hex string representation of the value

Returns: string


@@ -2363,7 +2363,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Overrides Struct.toJSON

-

Defined in Extrinsic.ts:170

+

Defined in Extrinsic.ts:170

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

Returns: any


@@ -2372,7 +2372,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2380,7 +2380,7 @@

toU8a

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

Overrides Struct.toU8a

-

Defined in Extrinsic.ts:178

+

Defined in Extrinsic.ts:178

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

Parameters:

@@ -2412,7 +2412,7 @@

<Static> decodeExtrinsic

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

-

Defined in Extrinsic.ts:44

+

Defined in Extrinsic.ts:44

Parameters:

@@ -2434,7 +2434,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2497,7 +2497,7 @@ diff --git a/docs/types/classes/_extrinsic_.extrinsic.md b/docs/types/classes/_extrinsic_.extrinsic.md index 3e8cec5d7c..64910704be 100644 --- a/docs/types/classes/_extrinsic_.extrinsic.md +++ b/docs/types/classes/_extrinsic_.extrinsic.md @@ -36,7 +36,7 @@ Can be: *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Extrinsic.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L36)* +*Defined in [Extrinsic.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -96,7 +96,7 @@ ___ getargs(): `Array`<[Codec](../interfaces/_types_.codec.md)> -*Defined in [Extrinsic.ts:71](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L71)* +*Defined in [Extrinsic.ts:71](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L71)* *__description__*: The arguments passed to for the call, exposes args so it is compatible with [Method](_method_.method.md) @@ -109,7 +109,7 @@ ___ getcallIndex(): `Uint8Array` -*Defined in [Extrinsic.ts:78](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L78)* +*Defined in [Extrinsic.ts:78](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L78)* *__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method @@ -122,7 +122,7 @@ ___ getdata(): `Uint8Array` -*Defined in [Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L85)* +*Defined in [Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L85)* *__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 [Extrinsic.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L92)* +*Defined in [Extrinsic.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L92)* *__description__*: The length of the value when encoded as a Uint8Array @@ -150,7 +150,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L101)* +*Defined in [Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L101)* *__description__*: Convernience function, encodes the extrinsic and returns the actual hash @@ -163,7 +163,7 @@ ___ getisSigned(): `boolean` -*Defined in [Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L110)* +*Defined in [Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L110)* *__description__*: `true` id the extrinsic is signed @@ -176,7 +176,7 @@ ___ getlength(): `number` -*Defined in [Extrinsic.ts:117](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L117)* +*Defined in [Extrinsic.ts:117](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L117)* *__description__*: The length of the encoded value @@ -189,7 +189,7 @@ ___ getmeta(): [FunctionMetadata](_metadata_modules_.functionmetadata.md) -*Defined in [Extrinsic.ts:124](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L124)* +*Defined in [Extrinsic.ts:124](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L124)* *__description__*: The [FunctionMetadata](_metadata_modules_.functionmetadata.md) that describes the extrinsic @@ -202,7 +202,7 @@ ___ getmethod(): [Method](_method_.method.md) -*Defined in [Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L131)* +*Defined in [Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L131)* *__description__*: The [Method](_method_.method.md) this extrinsic wraps @@ -215,7 +215,7 @@ ___ getsignature(): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) -*Defined in [Extrinsic.ts:138](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L138)* +*Defined in [Extrinsic.ts:138](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L138)* *__description__*: The [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) @@ -246,7 +246,7 @@ ___ ▸ **addSignature**(signer: * [Address](_address_.address.md) | `Uint8Array`*, signature: *`Uint8Array`*, nonce: *[AnyNumber](../modules/_types_.md#anynumber)*, era?: *[Uint8Array](_codec_u8a_.u8a.md#uint8array)*): [Extrinsic](_extrinsic_.extrinsic.md) -*Defined in [Extrinsic.ts:145](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L145)* +*Defined in [Extrinsic.ts:145](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L145)* *__description__*: Add an [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) to the extrinsic (already generated) @@ -339,7 +339,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -360,7 +360,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -433,7 +433,7 @@ ___ ▸ **sign**(signerPair: *`KeyringPair`*, nonce: *[AnyNumber](../modules/_types_.md#anynumber)*, blockHash: *[AnyU8a](../modules/_types_.md#anyu8a)*, era?: *[Uint8Array](_codec_u8a_.u8a.md#uint8array)*): [Extrinsic](_extrinsic_.extrinsic.md) -*Defined in [Extrinsic.ts:154](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L154)* +*Defined in [Extrinsic.ts:154](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L154)* *__description__*: Sign the extrinsic with a specific keypair @@ -457,7 +457,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -474,7 +474,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [Extrinsic.ts:163](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L163)* +*Defined in [Extrinsic.ts:163](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L163)* *__description__*: Returns a hex string representation of the value @@ -491,7 +491,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [Extrinsic.ts:170](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L170)* +*Defined in [Extrinsic.ts:170](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L170)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -508,7 +508,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -523,7 +523,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [Extrinsic.ts:178](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L178)* +*Defined in [Extrinsic.ts:178](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L178)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -557,7 +557,7 @@ ___ ▸ **decodeExtrinsic**(value: * `ExtrinsicValue` | [AnyU8a](../modules/_types_.md#anyu8a) | [Method](_method_.method.md)*): `ExtrinsicValue` | `Array`<`number`> | `Uint8Array` -*Defined in [Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Extrinsic.ts#L44)* +*Defined in [Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Extrinsic.ts#L44)* **Parameters:** @@ -576,7 +576,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_extrinsicera_.extrinsicera.html b/docs/types/classes/_extrinsicera_.extrinsicera.html index 01aadeee2b..1928172ae2 100644 --- a/docs/types/classes/_extrinsicera_.extrinsicera.html +++ b/docs/types/classes/_extrinsicera_.extrinsicera.html @@ -1976,7 +1976,7 @@

constructor

⊕ new ExtrinsicEra(value?: AnyU8a): ExtrinsicEra

Overrides U8a.constructor

-

Defined in ExtrinsicEra.ts:16

+

Defined in ExtrinsicEra.ts:16

Parameters:

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


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

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2718,7 +2718,7 @@

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

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

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

Parameters:

@@ -2749,7 +2749,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2758,7 +2758,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

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

Returns: any


@@ -2776,7 +2776,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2784,7 +2784,7 @@

toU8a

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

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

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

Parameters:

@@ -2816,7 +2816,7 @@

<Static> decodeExtrinsicEra

▸ decodeExtrinsicEra(value?: AnyU8a): Uint8Array

-

Defined in ExtrinsicEra.ts:23

+

Defined in ExtrinsicEra.ts:23

Parameters:

@@ -2877,7 +2877,7 @@ diff --git a/docs/types/classes/_extrinsicera_.extrinsicera.md b/docs/types/classes/_extrinsicera_.extrinsicera.md index 7c6651a595..3a98762146 100644 --- a/docs/types/classes/_extrinsicera_.extrinsicera.md +++ b/docs/types/classes/_extrinsicera_.extrinsicera.md @@ -27,7 +27,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [ExtrinsicEra.ts:16](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/ExtrinsicEra.ts#L16)* +*Defined in [ExtrinsicEra.ts:16](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/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/e79c6d8/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -132,7 +132,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -674,7 +674,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -698,7 +698,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -715,7 +715,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -749,7 +749,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -764,7 +764,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -798,7 +798,7 @@ ___ ▸ **decodeExtrinsicEra**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): `Uint8Array` -*Defined in [ExtrinsicEra.ts:23](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/ExtrinsicEra.ts#L23)* +*Defined in [ExtrinsicEra.ts:23](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/ExtrinsicEra.ts#L23)* **Parameters:** diff --git a/docs/types/classes/_extrinsics_.extrinsics.html b/docs/types/classes/_extrinsics_.extrinsics.html index fb74b4e6ef..f34ccc71c5 100644 --- a/docs/types/classes/_extrinsics_.extrinsics.html +++ b/docs/types/classes/_extrinsics_.extrinsics.html @@ -1979,7 +1979,7 @@

constructor

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

Inherited from Vector.constructor

-

Defined in codec/Vector.ts:22

+

Defined in codec/Vector.ts:22

Parameters:

@@ -2009,14 +2009,14 @@

Type

getType(): string

Inherited from Vector.Type

-

Defined in codec/Vector.ts:57

+

Defined in codec/Vector.ts:57

Returns: string


encodedLength

getencodedLength(): number

Inherited from Vector.encodedLength

-

Defined in codec/Vector.ts:64

+

Defined in codec/Vector.ts:64

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

Returns: number


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

getlength(): number

Inherited from Vector.length

Overrides Array.length

-

Defined in codec/Vector.ts:73

+

Defined in codec/Vector.ts:73

description: The length of the value

Returns: number


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

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

Inherited from Vector.filter

Overrides Array.filter

-

Defined in codec/Vector.ts:139

+

Defined in codec/Vector.ts:139

description: Filters the array with the callback

Parameters:

@@ -2759,7 +2759,7 @@

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

Inherited from Vector.map

Overrides Array.map

-

Defined in codec/Vector.ts:148

+

Defined in codec/Vector.ts:148

description: Maps the array with the callback

Type parameters:

U

@@ -3141,7 +3141,7 @@

toArray

▸ toArray(): Array<T>

Inherited from Vector.toArray

-

Defined in codec/Vector.ts:81

+

Defined in codec/Vector.ts:81

description: Converts the Object to an standard JavaScript Array

Returns: Array<T>


@@ -3150,7 +3150,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Vector.toHex

-

Defined in codec/Vector.ts:88

+

Defined in codec/Vector.ts:88

description: Returns a hex string representation of the value

Returns: string


@@ -3159,7 +3159,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Vector.toJSON

-

Defined in codec/Vector.ts:95

+

Defined in codec/Vector.ts:95

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

Returns: any


@@ -3177,7 +3177,7 @@

Implementation of Codec.toString

Inherited from Vector.toString

Overrides Array.toString

-

Defined in codec/Vector.ts:104

+

Defined in codec/Vector.ts:104

description: Returns the string representation of the value

Returns: string


@@ -3185,7 +3185,7 @@

toU8a

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

Inherited from Vector.toU8a

-

Defined in codec/Vector.ts:117

+

Defined in codec/Vector.ts:117

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

Parameters:

@@ -3243,7 +3243,7 @@

<Static> decodeVector

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

Inherited from Vector.decodeVector

-

Defined in codec/Vector.ts:32

+

Defined in codec/Vector.ts:32

Type parameters:

T : Codec

Parameters:

@@ -3271,7 +3271,7 @@

<Static> with

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

Inherited from Vector.with

-

Defined in codec/Vector.ts:49

+

Defined in codec/Vector.ts:49

Type parameters:

O : Codec

Parameters:

@@ -3334,7 +3334,7 @@ diff --git a/docs/types/classes/_extrinsics_.extrinsics.md b/docs/types/classes/_extrinsics_.extrinsics.md index 58c225a47c..423dfe309e 100644 --- a/docs/types/classes/_extrinsics_.extrinsics.md +++ b/docs/types/classes/_extrinsics_.extrinsics.md @@ -31,7 +31,7 @@ *Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)* -*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L22)* +*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L22)* **Parameters:** @@ -54,7 +54,7 @@ getType(): `string` *Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* -*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L57)* +*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L57)* **Returns:** `string` @@ -67,7 +67,7 @@ getencodedLength(): `number` *Inherited from [Vector](_codec_vector_.vector.md).[encodedLength](_codec_vector_.vector.md#encodedlength)* -*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L64)* +*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -84,7 +84,7 @@ getlength(): `number` *Overrides Array.length* -*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L73)* +*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L73)* *__description__*: The length of the value @@ -254,7 +254,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L139)* +*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L139)* *__description__*: Filters the array with the callback @@ -674,7 +674,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L148)* +*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L148)* *__description__*: Maps the array with the callback @@ -982,7 +982,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)* -*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L81)* +*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L81)* *__description__*: Converts the Object to an standard JavaScript Array @@ -999,7 +999,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)* -*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L88)* +*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L88)* *__description__*: Returns a hex string representation of the value @@ -1016,7 +1016,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* -*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L95)* +*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L95)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1050,7 +1050,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L104)* +*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L104)* *__description__*: Returns the string representation of the value @@ -1065,7 +1065,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* -*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L117)* +*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L117)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1122,7 +1122,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/e79c6d8/packages/types/src/codec/Vector.ts#L32)* +*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L32)* **Type parameters:** @@ -1145,7 +1145,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* -*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L49)* +*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L49)* **Type parameters:** diff --git a/docs/types/classes/_extrinsicsignature_.extrinsicsignature.html b/docs/types/classes/_extrinsicsignature_.extrinsicsignature.html index a17aa97db1..44c95c777f 100644 --- a/docs/types/classes/_extrinsicsignature_.extrinsicsignature.html +++ b/docs/types/classes/_extrinsicsignature_.extrinsicsignature.html @@ -1979,7 +1979,7 @@

constructor

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

Overrides Struct.constructor

-

Defined in ExtrinsicSignature.ts:37

+

Defined in ExtrinsicSignature.ts:37

Parameters:

@@ -2015,7 +2015,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2023,49 +2023,49 @@

encodedLength

getencodedLength(): number

Overrides Struct.encodedLength

-

Defined in ExtrinsicSignature.ts:71

+

Defined in ExtrinsicSignature.ts:71

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

Returns: number


era

getera(): ExtrinsicEra

-

Defined in ExtrinsicSignature.ts:90

+

Defined in ExtrinsicSignature.ts:90

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

Returns: ExtrinsicEra


isSigned

getisSigned(): boolean

-

Defined in ExtrinsicSignature.ts:83

+

Defined in ExtrinsicSignature.ts:83

description: true if the signature is valid

Returns: boolean


nonce

getnonce(): Nonce

-

Defined in ExtrinsicSignature.ts:97

+

Defined in ExtrinsicSignature.ts:97

description: The Nonce for the signature

Returns: Nonce


signature

getsignature(): Signature

-

Defined in ExtrinsicSignature.ts:104

+

Defined in ExtrinsicSignature.ts:104

description: The actuall Signature hash

Returns: Signature


signer

getsigner(): Address

-

Defined in ExtrinsicSignature.ts:111

+

Defined in ExtrinsicSignature.ts:111

description: The Address that signed

Returns: Address


version

getversion(): number

-

Defined in ExtrinsicSignature.ts:118

+

Defined in ExtrinsicSignature.ts:118

description: The encoded version for the signature

Returns: number


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

addSignature

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

-

Defined in ExtrinsicSignature.ts:142

+

Defined in ExtrinsicSignature.ts:142

description: Adds a raw signature

Parameters:

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

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2210,7 +2210,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

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

Parameters:

@@ -2288,7 +2288,7 @@

sign

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

-

Defined in ExtrinsicSignature.ts:154

+

Defined in ExtrinsicSignature.ts:154

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

Parameters:

@@ -2333,7 +2333,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


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

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


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

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

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

Returns: any


@@ -2360,7 +2360,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2368,7 +2368,7 @@

toU8a

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

Overrides Struct.toU8a

-

Defined in ExtrinsicSignature.ts:171

+

Defined in ExtrinsicSignature.ts:171

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

Parameters:

@@ -2400,7 +2400,7 @@

<Static> decodeExtrinsicSignature

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

-

Defined in ExtrinsicSignature.ts:52

+

Defined in ExtrinsicSignature.ts:52

Parameters:

@@ -2422,7 +2422,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2485,7 +2485,7 @@ diff --git a/docs/types/classes/_extrinsicsignature_.extrinsicsignature.md b/docs/types/classes/_extrinsicsignature_.extrinsicsignature.md index e151202c05..04dd8c53e1 100644 --- a/docs/types/classes/_extrinsicsignature_.extrinsicsignature.md +++ b/docs/types/classes/_extrinsicsignature_.extrinsicsignature.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [ExtrinsicSignature.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/ExtrinsicSignature.ts#L37)* +*Defined in [ExtrinsicSignature.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/ExtrinsicSignature.ts#L37)* **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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__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 [ExtrinsicSignature.ts:71](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/ExtrinsicSignature.ts#L71)* +*Defined in [ExtrinsicSignature.ts:71](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/ExtrinsicSignature.ts#L71)* *__description__*: The length of the value when encoded as a Uint8Array @@ -104,7 +104,7 @@ ___ getera(): [ExtrinsicEra](_extrinsicera_.extrinsicera.md) -*Defined in [ExtrinsicSignature.ts:90](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/ExtrinsicSignature.ts#L90)* +*Defined in [ExtrinsicSignature.ts:90](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/ExtrinsicSignature.ts#L90)* *__description__*: The [ExtrinsicEra](_extrinsicera_.extrinsicera.md) (mortal or immortal) this signature applies to @@ -117,7 +117,7 @@ ___ getisSigned(): `boolean` -*Defined in [ExtrinsicSignature.ts:83](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/ExtrinsicSignature.ts#L83)* +*Defined in [ExtrinsicSignature.ts:83](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/ExtrinsicSignature.ts#L83)* *__description__*: `true` if the signature is valid @@ -130,7 +130,7 @@ ___ getnonce(): [Nonce](_nonce_.nonce.md) -*Defined in [ExtrinsicSignature.ts:97](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/ExtrinsicSignature.ts#L97)* +*Defined in [ExtrinsicSignature.ts:97](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/ExtrinsicSignature.ts#L97)* *__description__*: The [Nonce](_nonce_.nonce.md) for the signature @@ -143,7 +143,7 @@ ___ getsignature(): [Signature](_signature_.signature.md) -*Defined in [ExtrinsicSignature.ts:104](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/ExtrinsicSignature.ts#L104)* +*Defined in [ExtrinsicSignature.ts:104](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/ExtrinsicSignature.ts#L104)* *__description__*: The actuall [Signature](_signature_.signature.md) hash @@ -156,7 +156,7 @@ ___ getsigner(): [Address](_address_.address.md) -*Defined in [ExtrinsicSignature.ts:111](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/ExtrinsicSignature.ts#L111)* +*Defined in [ExtrinsicSignature.ts:111](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/ExtrinsicSignature.ts#L111)* *__description__*: The [Address](_address_.address.md) that signed @@ -169,7 +169,7 @@ ___ getversion(): `number` -*Defined in [ExtrinsicSignature.ts:118](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/ExtrinsicSignature.ts#L118)* +*Defined in [ExtrinsicSignature.ts:118](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/ExtrinsicSignature.ts#L118)* *__description__*: The encoded version for the signature @@ -200,7 +200,7 @@ ___ ▸ **addSignature**(_signer: * [Address](_address_.address.md) | `Uint8Array`*, _signature: *`Uint8Array`*, _nonce: *[AnyNumber](../modules/_types_.md#anynumber)*, _era?: *`Uint8Array`*): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) -*Defined in [ExtrinsicSignature.ts:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/ExtrinsicSignature.ts#L142)* +*Defined in [ExtrinsicSignature.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/ExtrinsicSignature.ts#L142)* *__description__*: Adds a raw signature @@ -293,7 +293,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -314,7 +314,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -387,7 +387,7 @@ ___ ▸ **sign**(method: *[Method](_method_.method.md)*, signerPair: *`KeyringPair`*, nonce: *[AnyNumber](../modules/_types_.md#anynumber)*, blockHash: *[AnyU8a](../modules/_types_.md#anyu8a)*, era?: *`Uint8Array`*): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) -*Defined in [ExtrinsicSignature.ts:154](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/ExtrinsicSignature.ts#L154)* +*Defined in [ExtrinsicSignature.ts:154](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/ExtrinsicSignature.ts#L154)* *__description__*: Generate a payload and pplies the signature from a keypair @@ -412,7 +412,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -429,7 +429,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -446,7 +446,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -463,7 +463,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -478,7 +478,7 @@ ___ *Overrides [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [ExtrinsicSignature.ts:171](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/ExtrinsicSignature.ts#L171)* +*Defined in [ExtrinsicSignature.ts:171](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/ExtrinsicSignature.ts#L171)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -512,7 +512,7 @@ ___ ▸ **decodeExtrinsicSignature**(value: * [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) | `ExtrinsicSignatureValue` | [AnyU8a](../modules/_types_.md#anyu8a) | `undefined`*): `object` | `Uint8Array` -*Defined in [ExtrinsicSignature.ts:52](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/ExtrinsicSignature.ts#L52)* +*Defined in [ExtrinsicSignature.ts:52](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/ExtrinsicSignature.ts#L52)* **Parameters:** @@ -531,7 +531,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_extrinsicstatus_.broadcast.html b/docs/types/classes/_extrinsicstatus_.broadcast.html index 5829129ba4..96db392e6f 100644 --- a/docs/types/classes/_extrinsicstatus_.broadcast.html +++ b/docs/types/classes/_extrinsicstatus_.broadcast.html @@ -1978,7 +1978,7 @@

constructor

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

Inherited from Vector.constructor

-

Defined in codec/Vector.ts:22

+

Defined in codec/Vector.ts:22

Parameters:

@@ -2008,14 +2008,14 @@

Type

getType(): string

Inherited from Vector.Type

-

Defined in codec/Vector.ts:57

+

Defined in codec/Vector.ts:57

Returns: string


encodedLength

getencodedLength(): number

Inherited from Vector.encodedLength

-

Defined in codec/Vector.ts:64

+

Defined in codec/Vector.ts:64

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

Returns: number


@@ -2024,7 +2024,7 @@

getlength(): number

Inherited from Vector.length

Overrides Array.length

-

Defined in codec/Vector.ts:73

+

Defined in codec/Vector.ts:73

description: The length of the value

Returns: number


@@ -2205,7 +2205,7 @@

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

Inherited from Vector.filter

Overrides Array.filter

-

Defined in codec/Vector.ts:139

+

Defined in codec/Vector.ts:139

description: Filters the array with the callback

Parameters:

@@ -2758,7 +2758,7 @@

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

Inherited from Vector.map

Overrides Array.map

-

Defined in codec/Vector.ts:148

+

Defined in codec/Vector.ts:148

description: Maps the array with the callback

Type parameters:

U

@@ -3140,7 +3140,7 @@

toArray

▸ toArray(): Array<T>

Inherited from Vector.toArray

-

Defined in codec/Vector.ts:81

+

Defined in codec/Vector.ts:81

description: Converts the Object to an standard JavaScript Array

Returns: Array<T>


@@ -3149,7 +3149,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Vector.toHex

-

Defined in codec/Vector.ts:88

+

Defined in codec/Vector.ts:88

description: Returns a hex string representation of the value

Returns: string


@@ -3158,7 +3158,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Vector.toJSON

-

Defined in codec/Vector.ts:95

+

Defined in codec/Vector.ts:95

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

Returns: any


@@ -3176,7 +3176,7 @@

Implementation of Codec.toString

Inherited from Vector.toString

Overrides Array.toString

-

Defined in codec/Vector.ts:104

+

Defined in codec/Vector.ts:104

description: Returns the string representation of the value

Returns: string


@@ -3184,7 +3184,7 @@

toU8a

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

Inherited from Vector.toU8a

-

Defined in codec/Vector.ts:117

+

Defined in codec/Vector.ts:117

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

Parameters:

@@ -3242,7 +3242,7 @@

<Static> decodeVector

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

Inherited from Vector.decodeVector

-

Defined in codec/Vector.ts:32

+

Defined in codec/Vector.ts:32

Type parameters:

T : Codec

Parameters:

@@ -3270,7 +3270,7 @@

<Static> with

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

Inherited from Vector.with

-

Defined in codec/Vector.ts:49

+

Defined in codec/Vector.ts:49

Type parameters:

O : Codec

Parameters:

@@ -3333,7 +3333,7 @@ diff --git a/docs/types/classes/_extrinsicstatus_.broadcast.md b/docs/types/classes/_extrinsicstatus_.broadcast.md index c33b2337b9..c3e9928fd7 100644 --- a/docs/types/classes/_extrinsicstatus_.broadcast.md +++ b/docs/types/classes/_extrinsicstatus_.broadcast.md @@ -29,7 +29,7 @@ *Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)* -*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L22)* +*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L22)* **Parameters:** @@ -52,7 +52,7 @@ getType(): `string` *Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* -*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L57)* +*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L57)* **Returns:** `string` @@ -65,7 +65,7 @@ getencodedLength(): `number` *Inherited from [Vector](_codec_vector_.vector.md).[encodedLength](_codec_vector_.vector.md#encodedlength)* -*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L64)* +*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -82,7 +82,7 @@ getlength(): `number` *Overrides Array.length* -*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L73)* +*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L73)* *__description__*: The length of the value @@ -252,7 +252,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L139)* +*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L139)* *__description__*: Filters the array with the callback @@ -672,7 +672,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L148)* +*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L148)* *__description__*: Maps the array with the callback @@ -980,7 +980,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)* -*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L81)* +*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L81)* *__description__*: Converts the Object to an standard JavaScript Array @@ -997,7 +997,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)* -*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L88)* +*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L88)* *__description__*: Returns a hex string representation of the value @@ -1014,7 +1014,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* -*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L95)* +*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L95)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1048,7 +1048,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L104)* +*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L104)* *__description__*: Returns the string representation of the value @@ -1063,7 +1063,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* -*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L117)* +*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L117)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1120,7 +1120,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/e79c6d8/packages/types/src/codec/Vector.ts#L32)* +*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L32)* **Type parameters:** @@ -1143,7 +1143,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* -*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L49)* +*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L49)* **Type parameters:** diff --git a/docs/types/classes/_extrinsicstatus_.dropped.html b/docs/types/classes/_extrinsicstatus_.dropped.html index 15a0b7963b..f455639dc3 100644 --- a/docs/types/classes/_extrinsicstatus_.dropped.html +++ b/docs/types/classes/_extrinsicstatus_.dropped.html @@ -1974,7 +1974,7 @@

encodedLength

getencodedLength(): number

Inherited from Null.encodedLength

-

Defined in Null.ts:16

+

Defined in Null.ts:16

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

Returns: number


@@ -1984,7 +1984,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Null.toHex

-

Defined in Null.ts:23

+

Defined in Null.ts:23

description: Returns a hex string representation of the value

Returns: string


@@ -1993,7 +1993,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Null.toJSON

-

Defined in Null.ts:30

+

Defined in Null.ts:30

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

Returns: any


@@ -2002,7 +2002,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Null.toString

-

Defined in Null.ts:37

+

Defined in Null.ts:37

description: Returns the string representation of the value

Returns: string


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

toU8a

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

Inherited from Null.toU8a

-

Defined in Null.ts:45

+

Defined in Null.ts:45

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

Parameters:

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

constructor

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

Overrides EnumType.constructor

-

Defined in ExtrinsicStatus.ts:72

+

Defined in ExtrinsicStatus.ts:72

Parameters:

@@ -2001,7 +2001,7 @@

encodedLength

getencodedLength(): number

Inherited from EnumType.encodedLength

-

Defined in codec/EnumType.ts:97

+

Defined in codec/EnumType.ts:97

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

Returns: number


@@ -2009,7 +2009,7 @@

isNone

getisNone(): boolean

Inherited from EnumType.isNone

-

Defined in codec/EnumType.ts:104

+

Defined in codec/EnumType.ts:104

description: Checks if the Enum points to a Null type

Returns: boolean


@@ -2017,7 +2017,7 @@

isNull

getisNull(): boolean

Inherited from EnumType.isNull

-

Defined in codec/EnumType.ts:111

+

Defined in codec/EnumType.ts:111

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

Returns: boolean


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

type

gettype(): string

Inherited from EnumType.type

-

Defined in codec/EnumType.ts:118

+

Defined in codec/EnumType.ts:118

description: The name of the type this enum value represents

Returns: string


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

value

getvalue(): Codec

Inherited from EnumType.value

-

Defined in codec/EnumType.ts:125

+

Defined in codec/EnumType.ts:125

description: The value of the enum

Returns: Codec


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

▸ toHex(): string

Implementation of Codec.toHex

Inherited from EnumType.toHex

-

Defined in codec/EnumType.ts:132

+

Defined in codec/EnumType.ts:132

description: Returns a hex string representation of the value

Returns: string


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

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from EnumType.toJSON

-

Defined in codec/EnumType.ts:139

+

Defined in codec/EnumType.ts:139

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

Returns: any


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

toNumber

▸ toNumber(): number

Inherited from EnumType.toNumber

-

Defined in codec/EnumType.ts:146

+

Defined in codec/EnumType.ts:146

description: Returns the number representation for the value

Returns: number


@@ -2069,7 +2069,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from EnumType.toString

-

Defined in codec/EnumType.ts:153

+

Defined in codec/EnumType.ts:153

description: Returns the string representation of the value

Returns: string


@@ -2077,7 +2077,7 @@

toU8a

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

Inherited from EnumType.toU8a

-

Defined in codec/EnumType.ts:161

+

Defined in codec/EnumType.ts:161

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

Parameters:

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

⊕ new Finalised(value?: AnyU8a): Finalised

Inherited from H256.constructor

Overrides U8aFixed.constructor

-

Defined in H256.ts:15

+

Defined in H256.ts:15

Parameters:

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


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

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


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

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2727,7 +2727,7 @@

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

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

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

Parameters:

@@ -2758,7 +2758,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2767,7 +2767,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

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

Returns: any


@@ -2785,7 +2785,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2793,7 +2793,7 @@

toU8a

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

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

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

Parameters:

@@ -2865,7 +2865,7 @@ diff --git a/docs/types/classes/_extrinsicstatus_.finalised.md b/docs/types/classes/_extrinsicstatus_.finalised.md index ee4c5225c2..6986bc5bad 100644 --- a/docs/types/classes/_extrinsicstatus_.finalised.md +++ b/docs/types/classes/_extrinsicstatus_.finalised.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/H256.ts#L15)* +*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/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/e79c6d8/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -134,7 +134,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -165,7 +165,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -691,7 +691,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -715,7 +715,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -732,7 +732,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -766,7 +766,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -781,7 +781,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_extrinsicstatus_.future.md b/docs/types/classes/_extrinsicstatus_.future.md index 73d4d1c7fb..3a6aa7abf8 100644 --- a/docs/types/classes/_extrinsicstatus_.future.md +++ b/docs/types/classes/_extrinsicstatus_.future.md @@ -24,7 +24,7 @@ getencodedLength(): `number` *Inherited from [Null](_null_.null.md).[encodedLength](_null_.null.md#encodedlength)* -*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L16)* +*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L16)* *__description__*: The length of the value when encoded as a Uint8Array @@ -44,7 +44,7 @@ ___ *Inherited from [Null](_null_.null.md).[toHex](_null_.null.md#tohex)* -*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L23)* +*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L23)* *__description__*: Returns a hex string representation of the value @@ -61,7 +61,7 @@ ___ *Inherited from [Null](_null_.null.md).[toJSON](_null_.null.md#tojson)* -*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L30)* +*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L30)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -78,7 +78,7 @@ ___ *Inherited from [Null](_null_.null.md).[toString](_null_.null.md#tostring)* -*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L37)* +*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L37)* *__description__*: Returns the string representation of the value @@ -93,7 +93,7 @@ ___ *Inherited from [Null](_null_.null.md).[toU8a](_null_.null.md#tou8a)* -*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L45)* +*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L45)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_extrinsicstatus_.invalid.md b/docs/types/classes/_extrinsicstatus_.invalid.md index 8995987294..1a7b1bce2f 100644 --- a/docs/types/classes/_extrinsicstatus_.invalid.md +++ b/docs/types/classes/_extrinsicstatus_.invalid.md @@ -24,7 +24,7 @@ getencodedLength(): `number` *Inherited from [Null](_null_.null.md).[encodedLength](_null_.null.md#encodedlength)* -*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L16)* +*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L16)* *__description__*: The length of the value when encoded as a Uint8Array @@ -44,7 +44,7 @@ ___ *Inherited from [Null](_null_.null.md).[toHex](_null_.null.md#tohex)* -*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L23)* +*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L23)* *__description__*: Returns a hex string representation of the value @@ -61,7 +61,7 @@ ___ *Inherited from [Null](_null_.null.md).[toJSON](_null_.null.md#tojson)* -*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L30)* +*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L30)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -78,7 +78,7 @@ ___ *Inherited from [Null](_null_.null.md).[toString](_null_.null.md#tostring)* -*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L37)* +*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L37)* *__description__*: Returns the string representation of the value @@ -93,7 +93,7 @@ ___ *Inherited from [Null](_null_.null.md).[toU8a](_null_.null.md#tou8a)* -*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L45)* +*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L45)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_extrinsicstatus_.ready.md b/docs/types/classes/_extrinsicstatus_.ready.md index 73159dab5d..f0d2f580bf 100644 --- a/docs/types/classes/_extrinsicstatus_.ready.md +++ b/docs/types/classes/_extrinsicstatus_.ready.md @@ -24,7 +24,7 @@ getencodedLength(): `number` *Inherited from [Null](_null_.null.md).[encodedLength](_null_.null.md#encodedlength)* -*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L16)* +*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L16)* *__description__*: The length of the value when encoded as a Uint8Array @@ -44,7 +44,7 @@ ___ *Inherited from [Null](_null_.null.md).[toHex](_null_.null.md#tohex)* -*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L23)* +*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L23)* *__description__*: Returns a hex string representation of the value @@ -61,7 +61,7 @@ ___ *Inherited from [Null](_null_.null.md).[toJSON](_null_.null.md#tojson)* -*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L30)* +*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L30)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -78,7 +78,7 @@ ___ *Inherited from [Null](_null_.null.md).[toString](_null_.null.md#tostring)* -*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L37)* +*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L37)* *__description__*: Returns the string representation of the value @@ -93,7 +93,7 @@ ___ *Inherited from [Null](_null_.null.md).[toU8a](_null_.null.md#tou8a)* -*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L45)* +*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L45)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_extrinsicstatus_.usurped.html b/docs/types/classes/_extrinsicstatus_.usurped.html index d5855a9408..bd8f0827a7 100644 --- a/docs/types/classes/_extrinsicstatus_.usurped.html +++ b/docs/types/classes/_extrinsicstatus_.usurped.html @@ -1977,7 +1977,7 @@

⊕ new Usurped(value?: AnyU8a): Usurped

Inherited from H256.constructor

Overrides U8aFixed.constructor

-

Defined in H256.ts:15

+

Defined in H256.ts:15

Parameters:

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


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

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


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

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2727,7 +2727,7 @@

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

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

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

Parameters:

@@ -2758,7 +2758,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2767,7 +2767,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

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

Returns: any


@@ -2785,7 +2785,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2793,7 +2793,7 @@

toU8a

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

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

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

Parameters:

@@ -2865,7 +2865,7 @@ diff --git a/docs/types/classes/_extrinsicstatus_.usurped.md b/docs/types/classes/_extrinsicstatus_.usurped.md index 7753d65f60..cee9cd884e 100644 --- a/docs/types/classes/_extrinsicstatus_.usurped.md +++ b/docs/types/classes/_extrinsicstatus_.usurped.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/H256.ts#L15)* +*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/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/e79c6d8/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -134,7 +134,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -165,7 +165,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -691,7 +691,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -715,7 +715,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -732,7 +732,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -766,7 +766,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -781,7 +781,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_gas_.gas.html b/docs/types/classes/_gas_.gas.html index 30ffe63b3a..36c149892e 100644 --- a/docs/types/classes/_gas_.gas.html +++ b/docs/types/classes/_gas_.gas.html @@ -1975,7 +1975,7 @@

⊕ new Gas(value?: AnyNumber): Gas

Inherited from U64.constructor

Overrides UInt.constructor

-

Defined in U64.ts:14

+

Defined in U64.ts:14

Parameters:

@@ -1998,7 +1998,7 @@

encodedLength

getencodedLength(): number

Inherited from AbstractInt.encodedLength

-

Defined in codec/AbstractInt.ts:56

+

Defined in codec/AbstractInt.ts:56

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

Returns: number


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

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

-

Defined in codec/AbstractInt.ts:63

+

Defined in codec/AbstractInt.ts:63

description: Returns the number of bits in the value

Returns: UIntBitLength


@@ -3509,7 +3509,7 @@

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

-

Defined in codec/AbstractInt.ts:70

+

Defined in codec/AbstractInt.ts:70

description: Returns the BN representation of the number. (Compatibility)

Returns: BN


@@ -3546,7 +3546,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -3556,7 +3556,7 @@

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

-

Defined in codec/AbstractInt.ts:82

+

Defined in codec/AbstractInt.ts:82

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

Returns: any


@@ -3596,7 +3596,7 @@

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

-

Defined in codec/AbstractInt.ts:92

+

Defined in codec/AbstractInt.ts:92

description: Returns the string representation of the value

Parameters:

@@ -3645,7 +3645,7 @@

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

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -3862,7 +3862,7 @@

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

-

Defined in codec/AbstractInt.ts:37

+

Defined in codec/AbstractInt.ts:37

Parameters:

@@ -4054,7 +4054,7 @@ diff --git a/docs/types/classes/_gas_.gas.md b/docs/types/classes/_gas_.gas.md index fa5ab60763..a05452f228 100644 --- a/docs/types/classes/_gas_.gas.md +++ b/docs/types/classes/_gas_.gas.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/U64.ts#L14)* +*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/U64.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -188,7 +188,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1523,7 +1523,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1564,7 +1564,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1583,7 +1583,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1636,7 +1636,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1680,7 +1680,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1884,7 +1884,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_h256_.h256.html b/docs/types/classes/_h256_.h256.html index 697c1dec70..ca72f4dc51 100644 --- a/docs/types/classes/_h256_.h256.html +++ b/docs/types/classes/_h256_.h256.html @@ -1977,7 +1977,7 @@

constructor

⊕ new H256(value?: AnyU8a): H256

Overrides U8aFixed.constructor

-

Defined in H256.ts:15

+

Defined in H256.ts:15

Parameters:

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


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

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


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

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2727,7 +2727,7 @@

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

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

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

Parameters:

@@ -2758,7 +2758,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2767,7 +2767,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

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

Returns: any


@@ -2785,7 +2785,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2793,7 +2793,7 @@

toU8a

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

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

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

Parameters:

@@ -2865,7 +2865,7 @@ diff --git a/docs/types/classes/_h256_.h256.md b/docs/types/classes/_h256_.h256.md index 8de8f3f686..65b3f2986a 100644 --- a/docs/types/classes/_h256_.h256.md +++ b/docs/types/classes/_h256_.h256.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/H256.ts#L15)* +*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/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/e79c6d8/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -134,7 +134,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -165,7 +165,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -691,7 +691,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -715,7 +715,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -732,7 +732,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -766,7 +766,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -781,7 +781,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_h512_.h512.html b/docs/types/classes/_h512_.h512.html index 50f0699ef0..38a5e4f3e5 100644 --- a/docs/types/classes/_h512_.h512.html +++ b/docs/types/classes/_h512_.h512.html @@ -1977,7 +1977,7 @@

constructor

⊕ new H512(value?: AnyU8a): H512

Overrides U8aFixed.constructor

-

Defined in H512.ts:14

+

Defined in H512.ts:14

Parameters:

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


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

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


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

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2727,7 +2727,7 @@

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

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

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

Parameters:

@@ -2758,7 +2758,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2767,7 +2767,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

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

Returns: any


@@ -2785,7 +2785,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2793,7 +2793,7 @@

toU8a

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

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

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

Parameters:

@@ -2865,7 +2865,7 @@ diff --git a/docs/types/classes/_h512_.h512.md b/docs/types/classes/_h512_.h512.md index c7e6b67f7e..a36355576f 100644 --- a/docs/types/classes/_h512_.h512.md +++ b/docs/types/classes/_h512_.h512.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/H512.ts#L14)* +*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/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/e79c6d8/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -134,7 +134,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -165,7 +165,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -691,7 +691,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -715,7 +715,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -732,7 +732,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -766,7 +766,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -781,7 +781,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_hash_.hash.html b/docs/types/classes/_hash_.hash.html index 12b9e8b172..27777a81f3 100644 --- a/docs/types/classes/_hash_.hash.html +++ b/docs/types/classes/_hash_.hash.html @@ -1980,7 +1980,7 @@

⊕ new Hash(value?: AnyU8a): Hash

Inherited from H256.constructor

Overrides U8aFixed.constructor

-

Defined in H256.ts:15

+

Defined in H256.ts:15

Parameters:

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

encodedLength

getencodedLength(): number

Inherited from U8a.encodedLength

-

Defined in codec/U8a.ts:36

+

Defined in codec/U8a.ts:36

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

Returns: number


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

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


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

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2730,7 +2730,7 @@

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

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

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

Parameters:

@@ -2761,7 +2761,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2770,7 +2770,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

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

Returns: any


@@ -2788,7 +2788,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2796,7 +2796,7 @@

toU8a

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

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

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

Parameters:

@@ -2868,7 +2868,7 @@ diff --git a/docs/types/classes/_hash_.hash.md b/docs/types/classes/_hash_.hash.md index 8bf2db88d2..984753c5b5 100644 --- a/docs/types/classes/_hash_.hash.md +++ b/docs/types/classes/_hash_.hash.md @@ -35,7 +35,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/H256.ts#L15)* +*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/H256.ts#L15)* **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/e79c6d8/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -140,7 +140,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -171,7 +171,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -697,7 +697,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -721,7 +721,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -738,7 +738,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -772,7 +772,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -787,7 +787,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_header_.header.html b/docs/types/classes/_header_.header.html index 32568c23e2..53024c87a3 100644 --- a/docs/types/classes/_header_.header.html +++ b/docs/types/classes/_header_.header.html @@ -1979,7 +1979,7 @@

constructor

⊕ new Header(value?: HeaderValue | Uint8Array): Header

Overrides Struct.constructor

-

Defined in Header.ts:29

+

Defined in Header.ts:29

Parameters:

@@ -2015,21 +2015,21 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


blockNumber

getblockNumber(): BlockNumber

-

Defined in Header.ts:43

+

Defined in Header.ts:43

description: The wrapped BlockNumber

Returns: BlockNumber


digest

getdigest(): Digest

-

Defined in Header.ts:50

+

Defined in Header.ts:50

description: The wrapped Digest

Returns: Digest


@@ -2037,35 +2037,35 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


extrinsicsRoot

getextrinsicsRoot(): Hash

-

Defined in Header.ts:57

+

Defined in Header.ts:57

description: The wrapped extrisics root as a Hash

Returns: Hash


hash

gethash(): Hash

-

Defined in Header.ts:64

+

Defined in Header.ts:64

description: Convenience method, encodes the header and calculates the Hash

Returns: Hash


parentHash

getparentHash(): Hash

-

Defined in Header.ts:73

+

Defined in Header.ts:73

description: The wrapped parent as a Hash

Returns: Hash


stateRoot

getstateRoot(): Hash

-

Defined in Header.ts:80

+

Defined in Header.ts:80

description: The wrapped state root as a Hash

Returns: Hash


@@ -2146,7 +2146,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

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

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

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

Parameters:

@@ -2250,7 +2250,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2259,7 +2259,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


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

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

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

Returns: any


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

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


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

toU8a

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

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

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

Parameters:

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

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2381,7 +2381,7 @@ diff --git a/docs/types/classes/_header_.header.md b/docs/types/classes/_header_.header.md index 28edf2a559..d1e7d456ce 100644 --- a/docs/types/classes/_header_.header.md +++ b/docs/types/classes/_header_.header.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Header.ts:29](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Header.ts#L29)* +*Defined in [Header.ts:29](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Header.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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -89,7 +89,7 @@ ___ getblockNumber(): [BlockNumber](_blocknumber_.blocknumber.md) -*Defined in [Header.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Header.ts#L43)* +*Defined in [Header.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Header.ts#L43)* *__description__*: The wrapped [BlockNumber](_blocknumber_.blocknumber.md) @@ -102,7 +102,7 @@ ___ getdigest(): [Digest](_digest_.digest.md) -*Defined in [Header.ts:50](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Header.ts#L50)* +*Defined in [Header.ts:50](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Header.ts#L50)* *__description__*: The wrapped [Digest](_digest_.digest.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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -130,7 +130,7 @@ ___ getextrinsicsRoot(): [Hash](_hash_.hash.md) -*Defined in [Header.ts:57](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Header.ts#L57)* +*Defined in [Header.ts:57](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Header.ts#L57)* *__description__*: The wrapped extrisics root as a [Hash](_hash_.hash.md) @@ -143,7 +143,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Header.ts:64](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Header.ts#L64)* +*Defined in [Header.ts:64](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Header.ts#L64)* *__description__*: Convenience method, encodes the header and calculates the [Hash](_hash_.hash.md) @@ -156,7 +156,7 @@ ___ getparentHash(): [Hash](_hash_.hash.md) -*Defined in [Header.ts:73](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Header.ts#L73)* +*Defined in [Header.ts:73](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Header.ts#L73)* *__description__*: The wrapped parent as a [Hash](_hash_.hash.md) @@ -169,7 +169,7 @@ ___ getstateRoot(): [Hash](_hash_.hash.md) -*Defined in [Header.ts:80](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Header.ts#L80)* +*Defined in [Header.ts:80](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Header.ts#L80)* *__description__*: The wrapped state root as a [Hash](_hash_.hash.md) @@ -271,7 +271,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__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:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -367,7 +367,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -384,7 +384,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -401,7 +401,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -418,7 +418,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -433,7 +433,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -469,7 +469,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_i128_.i128.md b/docs/types/classes/_i128_.i128.md index 0976515bfa..8cb8890c3e 100644 --- a/docs/types/classes/_i128_.i128.md +++ b/docs/types/classes/_i128_.i128.md @@ -24,7 +24,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [I128.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/I128.ts#L14)* +*Defined in [I128.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/I128.ts#L14)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -186,7 +186,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1521,7 +1521,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1562,7 +1562,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1581,7 +1581,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1634,7 +1634,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1678,7 +1678,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1882,7 +1882,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_i16_.i16.md b/docs/types/classes/_i16_.i16.md index de20cf9c8a..ea86904ff5 100644 --- a/docs/types/classes/_i16_.i16.md +++ b/docs/types/classes/_i16_.i16.md @@ -24,7 +24,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [I16.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/I16.ts#L14)* +*Defined in [I16.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/I16.ts#L14)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -186,7 +186,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1521,7 +1521,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1562,7 +1562,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1581,7 +1581,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1634,7 +1634,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1678,7 +1678,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1882,7 +1882,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_i256_.i256.md b/docs/types/classes/_i256_.i256.md index 77687c1157..a668a11969 100644 --- a/docs/types/classes/_i256_.i256.md +++ b/docs/types/classes/_i256_.i256.md @@ -24,7 +24,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [I256.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/I256.ts#L14)* +*Defined in [I256.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/I256.ts#L14)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -186,7 +186,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1521,7 +1521,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1562,7 +1562,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1581,7 +1581,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1634,7 +1634,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1678,7 +1678,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1882,7 +1882,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_i32_.i32.md b/docs/types/classes/_i32_.i32.md index 0a2c7f2064..d7cbae1537 100644 --- a/docs/types/classes/_i32_.i32.md +++ b/docs/types/classes/_i32_.i32.md @@ -24,7 +24,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [I32.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/I32.ts#L14)* +*Defined in [I32.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/I32.ts#L14)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -186,7 +186,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1521,7 +1521,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1562,7 +1562,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1581,7 +1581,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1634,7 +1634,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1678,7 +1678,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1882,7 +1882,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_i64_.i64.md b/docs/types/classes/_i64_.i64.md index 2efa99f88d..93137bcce2 100644 --- a/docs/types/classes/_i64_.i64.md +++ b/docs/types/classes/_i64_.i64.md @@ -24,7 +24,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [I64.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/I64.ts#L14)* +*Defined in [I64.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/I64.ts#L14)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -186,7 +186,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1521,7 +1521,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1562,7 +1562,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1581,7 +1581,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1634,7 +1634,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1678,7 +1678,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1882,7 +1882,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_i8_.i8.md b/docs/types/classes/_i8_.i8.md index a2f4ff5cc6..e5ec956f7d 100644 --- a/docs/types/classes/_i8_.i8.md +++ b/docs/types/classes/_i8_.i8.md @@ -28,7 +28,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [I8.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/I8.ts#L14)* +*Defined in [I8.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/I8.ts#L14)* **Parameters:** @@ -50,7 +50,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -190,7 +190,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1525,7 +1525,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1566,7 +1566,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1585,7 +1585,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1638,7 +1638,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1682,7 +1682,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1886,7 +1886,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_inherentofflinereport_.inherentofflinereport.md b/docs/types/classes/_inherentofflinereport_.inherentofflinereport.md index 62c2a260c2..1fea0e2dd5 100644 --- a/docs/types/classes/_inherentofflinereport_.inherentofflinereport.md +++ b/docs/types/classes/_inherentofflinereport_.inherentofflinereport.md @@ -29,7 +29,7 @@ *Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [codec/Tuple.ts:20](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L20)* +*Defined in [codec/Tuple.ts:20](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L20)* **Parameters:** @@ -68,7 +68,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L65)* +*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L65)* *__description__*: The types definition of the tuple @@ -83,7 +83,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L56)* +*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -253,7 +253,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L121)* +*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L121)* *__description__*: Filters the array with the callback @@ -673,7 +673,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L130)* +*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L130)* *__description__*: Maps the array with the callback @@ -981,7 +981,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L72)* +*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L72)* *__description__*: Converts the Object to an standard JavaScript Array @@ -998,7 +998,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L79)* +*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L79)* *__description__*: Returns a hex string representation of the value @@ -1015,7 +1015,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L86)* +*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L86)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1049,7 +1049,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L95)* +*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L95)* *__description__*: Returns the string representation of the value @@ -1064,7 +1064,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L104)* +*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L104)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1121,7 +1121,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L43)* +*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L43)* **Type parameters:** diff --git a/docs/types/classes/_justification_.justification.html b/docs/types/classes/_justification_.justification.html index fdf7e2939a..8531e66e90 100644 --- a/docs/types/classes/_justification_.justification.html +++ b/docs/types/classes/_justification_.justification.html @@ -1977,7 +1977,7 @@

⊕ new Justification(value: AnyU8a): Justification

Inherited from Bytes.constructor

Overrides U8a.constructor

-

Defined in Bytes.ts:18

+

Defined in Bytes.ts:18

Parameters:

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

getencodedLength(): number

Inherited from Bytes.encodedLength

Overrides U8a.encodedLength

-

Defined in Bytes.ts:64

+

Defined in Bytes.ts:64

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

Returns: number


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

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2720,7 +2720,7 @@

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

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

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

Parameters:

@@ -2751,7 +2751,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2760,7 +2760,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

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

Returns: any


@@ -2778,7 +2778,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2787,7 +2787,7 @@

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

Inherited from Bytes.toU8a

Overrides U8a.toU8a

-

Defined in Bytes.ts:72

+

Defined in Bytes.ts:72

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

Parameters:

@@ -2859,7 +2859,7 @@ diff --git a/docs/types/classes/_justification_.justification.md b/docs/types/classes/_justification_.justification.md index f995bcb783..b7820540b5 100644 --- a/docs/types/classes/_justification_.justification.md +++ b/docs/types/classes/_justification_.justification.md @@ -29,7 +29,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bytes.ts#L18)* +*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bytes.ts#L18)* **Parameters:** @@ -119,7 +119,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bytes.ts#L64)* +*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bytes.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -136,7 +136,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -678,7 +678,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -702,7 +702,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -719,7 +719,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -753,7 +753,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -770,7 +770,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bytes.ts#L72)* +*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bytes.ts#L72)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_justification_.rhdjustification.html b/docs/types/classes/_justification_.rhdjustification.html index 9b263021f1..14e6c320d1 100644 --- a/docs/types/classes/_justification_.rhdjustification.html +++ b/docs/types/classes/_justification_.rhdjustification.html @@ -1979,7 +1979,7 @@

constructor

⊕ new RhdJustification(value?: RhdJustificationValue | Uint8Array): RhdJustification

Overrides Struct.constructor

-

Defined in Justification.ts:33

+

Defined in Justification.ts:33

Parameters:

@@ -2015,7 +2015,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2023,28 +2023,28 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


hash

gethash(): Hash

-

Defined in Justification.ts:47

+

Defined in Justification.ts:47

description: The justification Hash

Returns: Hash


roundNumber

getroundNumber(): U32

-

Defined in Justification.ts:54

+

Defined in Justification.ts:54

description: The round this justification wraps as a U32

Returns: U32


signatures

getsignatures(): Vector<BftAuthoritySignature>

-

Defined in Justification.ts:61

+

Defined in Justification.ts:61

description: The BftAuthoritySignature array

Returns: Vector<BftAuthoritySignature>


@@ -2125,7 +2125,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

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

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

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

Parameters:

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

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


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

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


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

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

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

Returns: any


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

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


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

toU8a

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

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

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

Parameters:

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

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2360,7 +2360,7 @@ diff --git a/docs/types/classes/_justification_.rhdjustification.md b/docs/types/classes/_justification_.rhdjustification.md index 8356de212a..7eb83aa850 100644 --- a/docs/types/classes/_justification_.rhdjustification.md +++ b/docs/types/classes/_justification_.rhdjustification.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Justification.ts:33](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Justification.ts#L33)* +*Defined in [Justification.ts:33](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -104,7 +104,7 @@ ___ gethash(): [Hash](_hash_.hash.md) -*Defined in [Justification.ts:47](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Justification.ts#L47)* +*Defined in [Justification.ts:47](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Justification.ts#L47)* *__description__*: The justification [Hash](_hash_.hash.md) @@ -117,7 +117,7 @@ ___ getroundNumber(): [U32](_u32_.u32.md) -*Defined in [Justification.ts:54](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Justification.ts#L54)* +*Defined in [Justification.ts:54](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Justification.ts#L54)* *__description__*: The round this justification wraps as a [U32](_u32_.u32.md) @@ -130,7 +130,7 @@ ___ getsignatures(): [Vector](_codec_vector_.vector.md)<[BftAuthoritySignature](_bft_.bftauthoritysignature.md)> -*Defined in [Justification.ts:61](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Justification.ts#L61)* +*Defined in [Justification.ts:61](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Justification.ts#L61)* *__description__*: The [BftAuthoritySignature](_bft_.bftauthoritysignature.md) array @@ -232,7 +232,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -253,7 +253,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -328,7 +328,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -345,7 +345,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -362,7 +362,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -379,7 +379,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -394,7 +394,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -430,7 +430,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_keyvalue_.keyvalue.html b/docs/types/classes/_keyvalue_.keyvalue.html index 84a96f0bd0..778350132d 100644 --- a/docs/types/classes/_keyvalue_.keyvalue.html +++ b/docs/types/classes/_keyvalue_.keyvalue.html @@ -1979,7 +1979,7 @@

constructor

⊕ new KeyValue(value?: KeyValueValue | Uint8Array): KeyValue

Overrides Struct.constructor

-

Defined in KeyValue.ts:26

+

Defined in KeyValue.ts:26

Parameters:

@@ -2015,7 +2015,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2023,21 +2023,21 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


key

getkey(): StorageKey

-

Defined in KeyValue.ts:37

+

Defined in KeyValue.ts:37

description: The StorageKey

Returns: StorageKey


value

getvalue(): StorageData

-

Defined in KeyValue.ts:44

+

Defined in KeyValue.ts:44

description: The StorageData

Returns: StorageData


@@ -2118,7 +2118,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

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

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

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

Parameters:

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

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


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

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


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

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

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

Returns: any


@@ -2249,7 +2249,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2257,7 +2257,7 @@

toU8a

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

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

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

Parameters:

@@ -2290,7 +2290,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2353,7 +2353,7 @@ diff --git a/docs/types/classes/_keyvalue_.keyvalue.md b/docs/types/classes/_keyvalue_.keyvalue.md index abbf8acaf8..5d511b3179 100644 --- a/docs/types/classes/_keyvalue_.keyvalue.md +++ b/docs/types/classes/_keyvalue_.keyvalue.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [KeyValue.ts:26](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/KeyValue.ts#L26)* +*Defined in [KeyValue.ts:26](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -104,7 +104,7 @@ ___ getkey(): [StorageKey](_storagekey_.storagekey.md) -*Defined in [KeyValue.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/KeyValue.ts#L37)* +*Defined in [KeyValue.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/KeyValue.ts#L37)* *__description__*: The [StorageKey](_storagekey_.storagekey.md) @@ -117,7 +117,7 @@ ___ getvalue(): [StorageData](_storagedata_.storagedata.md) -*Defined in [KeyValue.ts:44](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/KeyValue.ts#L44)* +*Defined in [KeyValue.ts:44](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/KeyValue.ts#L44)* *__description__*: The [StorageData](_storagedata_.storagedata.md) @@ -219,7 +219,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -240,7 +240,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -315,7 +315,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -332,7 +332,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -381,7 +381,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -417,7 +417,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_keyvalue_.keyvalueoption.html b/docs/types/classes/_keyvalue_.keyvalueoption.html index 3a50817105..8a1bec0e1e 100644 --- a/docs/types/classes/_keyvalue_.keyvalueoption.html +++ b/docs/types/classes/_keyvalue_.keyvalueoption.html @@ -1978,7 +1978,7 @@

constructor

⊕ new KeyValueOption(value?: KeyValueOptionValue | Uint8Array): KeyValueOption

Overrides Tuple.constructor

-

Defined in KeyValue.ts:58

+

Defined in KeyValue.ts:58

Parameters:

@@ -2009,7 +2009,7 @@

Types

getTypes(): Array<string>

Inherited from Tuple.Types

-

Defined in codec/Tuple.ts:65

+

Defined in codec/Tuple.ts:65

description: The types definition of the tuple

Returns: Array<string>


@@ -2017,21 +2017,21 @@

encodedLength

getencodedLength(): number

Inherited from Tuple.encodedLength

-

Defined in codec/Tuple.ts:56

+

Defined in codec/Tuple.ts:56

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

Returns: number


key

getkey(): StorageKey

-

Defined in KeyValue.ts:69

+

Defined in KeyValue.ts:69

description: The StorageKey

Returns: StorageKey


value

getvalue(): Option<StorageData>

-

Defined in KeyValue.ts:76

+

Defined in KeyValue.ts:76

description: The Option StorageData

Returns: Option<StorageData>


@@ -2212,7 +2212,7 @@

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

Inherited from Tuple.filter

Overrides Array.filter

-

Defined in codec/Tuple.ts:121

+

Defined in codec/Tuple.ts:121

description: Filters the array with the callback

Parameters:

@@ -2765,7 +2765,7 @@

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

Inherited from Tuple.map

Overrides Array.map

-

Defined in codec/Tuple.ts:130

+

Defined in codec/Tuple.ts:130

description: Maps the array with the callback

Type parameters:

U

@@ -3147,7 +3147,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

-

Defined in codec/Tuple.ts:72

+

Defined in codec/Tuple.ts:72

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -3156,7 +3156,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

-

Defined in codec/Tuple.ts:79

+

Defined in codec/Tuple.ts:79

description: Returns a hex string representation of the value

Returns: string


@@ -3165,7 +3165,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

-

Defined in codec/Tuple.ts:86

+

Defined in codec/Tuple.ts:86

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

Returns: any


@@ -3183,7 +3183,7 @@

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:95

+

Defined in codec/Tuple.ts:95

description: Returns the string representation of the value

Returns: string


@@ -3191,7 +3191,7 @@

toU8a

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

Inherited from Tuple.toU8a

-

Defined in codec/Tuple.ts:104

+

Defined in codec/Tuple.ts:104

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

Parameters:

@@ -3249,7 +3249,7 @@

<Static> with

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

Inherited from Tuple.with

-

Defined in codec/Tuple.ts:43

+

Defined in codec/Tuple.ts:43

Type parameters:

S : Array<Constructor>

Parameters:

@@ -3312,7 +3312,7 @@ diff --git a/docs/types/classes/_keyvalue_.keyvalueoption.md b/docs/types/classes/_keyvalue_.keyvalueoption.md index c55c1003d5..e9b25625fe 100644 --- a/docs/types/classes/_keyvalue_.keyvalueoption.md +++ b/docs/types/classes/_keyvalue_.keyvalueoption.md @@ -29,7 +29,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [KeyValue.ts:58](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/KeyValue.ts#L58)* +*Defined in [KeyValue.ts:58](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/KeyValue.ts#L58)* **Parameters:** @@ -67,7 +67,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L65)* +*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L65)* *__description__*: The types definition of the tuple @@ -82,7 +82,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L56)* +*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -95,7 +95,7 @@ ___ getkey(): [StorageKey](_storagekey_.storagekey.md) -*Defined in [KeyValue.ts:69](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/KeyValue.ts#L69)* +*Defined in [KeyValue.ts:69](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/KeyValue.ts#L69)* *__description__*: The [StorageKey](_storagekey_.storagekey.md) @@ -108,7 +108,7 @@ ___ getvalue(): [Option](_codec_option_.option.md)<[StorageData](_storagedata_.storagedata.md)> -*Defined in [KeyValue.ts:76](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/KeyValue.ts#L76)* +*Defined in [KeyValue.ts:76](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/KeyValue.ts#L76)* *__description__*: The [Option](_codec_option_.option.md) [StorageData](_storagedata_.storagedata.md) @@ -278,7 +278,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L121)* +*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L121)* *__description__*: Filters the array with the callback @@ -698,7 +698,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L130)* +*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L130)* *__description__*: Maps the array with the callback @@ -1006,7 +1006,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L72)* +*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L72)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1023,7 +1023,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L79)* +*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L79)* *__description__*: Returns a hex string representation of the value @@ -1040,7 +1040,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L86)* +*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L86)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1074,7 +1074,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L95)* +*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L95)* *__description__*: Returns the string representation of the value @@ -1089,7 +1089,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L104)* +*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L104)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1146,7 +1146,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L43)* +*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L43)* **Type parameters:** diff --git a/docs/types/classes/_lockperiods_.lockperiods.md b/docs/types/classes/_lockperiods_.lockperiods.md index 7469525cb6..97d99c039f 100644 --- a/docs/types/classes/_lockperiods_.lockperiods.md +++ b/docs/types/classes/_lockperiods_.lockperiods.md @@ -26,7 +26,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [I8.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/I8.ts#L14)* +*Defined in [I8.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/I8.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -188,7 +188,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1523,7 +1523,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1564,7 +1564,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1583,7 +1583,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1636,7 +1636,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1680,7 +1680,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1884,7 +1884,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_metadata_calls_.outerdispatchcall.md b/docs/types/classes/_metadata_calls_.outerdispatchcall.md index 920b98f844..ce1bb008a6 100644 --- a/docs/types/classes/_metadata_calls_.outerdispatchcall.md +++ b/docs/types/classes/_metadata_calls_.outerdispatchcall.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Calls.ts:10](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Calls.ts#L10)* +*Defined in [Metadata/Calls.ts:10](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -100,7 +100,7 @@ ___ getindex(): [U16](_u16_.u16.md) -*Defined in [Metadata/Calls.ts:22](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Calls.ts#L22)* +*Defined in [Metadata/Calls.ts:22](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Calls.ts#L22)* *__description__*: The [U16](_u16_.u16.md) index for the call @@ -113,7 +113,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/Calls.ts:29](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Calls.ts#L29)* +*Defined in [Metadata/Calls.ts:29](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Calls.ts#L29)* *__description__*: The name for the call @@ -126,7 +126,7 @@ ___ getprefix(): [Text](_text_.text.md) -*Defined in [Metadata/Calls.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Calls.ts#L36)* +*Defined in [Metadata/Calls.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Calls.ts#L36)* *__description__*: The call prefix (or section) @@ -228,7 +228,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -249,7 +249,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -324,7 +324,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -341,7 +341,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -358,7 +358,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -375,7 +375,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -390,7 +390,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -426,7 +426,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_calls_.outerdispatchmetadata.md b/docs/types/classes/_metadata_calls_.outerdispatchmetadata.md index a7b9c266d2..9f0da17573 100644 --- a/docs/types/classes/_metadata_calls_.outerdispatchmetadata.md +++ b/docs/types/classes/_metadata_calls_.outerdispatchmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Calls.ts:41](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Calls.ts#L41)* +*Defined in [Metadata/Calls.ts:41](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -85,7 +85,7 @@ ___ getcalls(): [Vector](_codec_vector_.vector.md)<[OuterDispatchCall](_metadata_calls_.outerdispatchcall.md)> -*Defined in [Metadata/Calls.ts:52](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Calls.ts#L52)* +*Defined in [Metadata/Calls.ts:52](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -113,7 +113,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/Calls.ts:59](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Calls.ts#L59)* +*Defined in [Metadata/Calls.ts:59](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Calls.ts#L59)* *__description__*: The name for the dispatch @@ -215,7 +215,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -236,7 +236,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -311,7 +311,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -328,7 +328,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -345,7 +345,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -362,7 +362,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -377,7 +377,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -413,7 +413,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_events_.eventmetadata.md b/docs/types/classes/_metadata_events_.eventmetadata.md index ee519dd018..554c8d356a 100644 --- a/docs/types/classes/_metadata_events_.eventmetadata.md +++ b/docs/types/classes/_metadata_events_.eventmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Events.ts:11](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Events.ts#L11)* +*Defined in [Metadata/Events.ts:11](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -85,7 +85,7 @@ ___ getarguments(): [Vector](_codec_vector_.vector.md)<[Type](_type_.type.md)> -*Defined in [Metadata/Events.ts:23](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Events.ts#L23)* +*Defined in [Metadata/Events.ts:23](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Events.ts#L23)* *__description__*: The arguments of [Type](_metadata_events_.eventmetadata.md#type) @@ -98,7 +98,7 @@ ___ getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> -*Defined in [Metadata/Events.ts:30](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Events.ts#L30)* +*Defined in [Metadata/Events.ts:30](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Events.ts#L30)* *__description__*: The [Text](_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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -126,7 +126,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/Events.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Events.ts#L37)* +*Defined in [Metadata/Events.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Events.ts#L37)* *__description__*: The name for the event @@ -228,7 +228,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -249,7 +249,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -324,7 +324,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -341,7 +341,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -358,7 +358,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -375,7 +375,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -390,7 +390,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -426,7 +426,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_events_.outereventmetadata.md b/docs/types/classes/_metadata_events_.outereventmetadata.md index ef1dfab04f..abe34ede51 100644 --- a/docs/types/classes/_metadata_events_.outereventmetadata.md +++ b/docs/types/classes/_metadata_events_.outereventmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Events.ts:65](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Events.ts#L65)* +*Defined in [Metadata/Events.ts:65](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -100,7 +100,7 @@ ___ getevents(): [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_events_.outereventmetadataevent.md)> -*Defined in [Metadata/Events.ts:76](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Events.ts#L76)* +*Defined in [Metadata/Events.ts:76](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Events.ts#L76)* *__description__*: The [OuterEventMetadataEvent](_metadata_events_.outereventmetadataevent.md) @@ -113,7 +113,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/Events.ts:83](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Events.ts#L83)* +*Defined in [Metadata/Events.ts:83](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Events.ts#L83)* *__description__*: The name of the event @@ -215,7 +215,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -236,7 +236,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -311,7 +311,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -328,7 +328,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -345,7 +345,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -362,7 +362,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -377,7 +377,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -413,7 +413,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_events_.outereventmetadataevent.md b/docs/types/classes/_metadata_events_.outereventmetadataevent.md index 45a824bd9c..776215847a 100644 --- a/docs/types/classes/_metadata_events_.outereventmetadataevent.md +++ b/docs/types/classes/_metadata_events_.outereventmetadataevent.md @@ -25,7 +25,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [Metadata/Events.ts:42](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Events.ts#L42)* +*Defined in [Metadata/Events.ts:42](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Events.ts#L42)* **Parameters:** @@ -63,7 +63,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L65)* +*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L65)* *__description__*: The types definition of the tuple @@ -78,7 +78,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L56)* +*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -91,7 +91,7 @@ ___ getevents(): [Vector](_codec_vector_.vector.md)<[EventMetadata](_metadata_events_.eventmetadata.md)> -*Defined in [Metadata/Events.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Events.ts#L53)* +*Defined in [Metadata/Events.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Events.ts#L53)* *__description__*: The [EventMetadata](_metadata_events_.eventmetadata.md) @@ -104,7 +104,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/Events.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Events.ts#L60)* +*Defined in [Metadata/Events.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Events.ts#L60)* *__description__*: The name of the section @@ -274,7 +274,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L121)* +*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L121)* *__description__*: Filters the array with the callback @@ -694,7 +694,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L130)* +*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L130)* *__description__*: Maps the array with the callback @@ -1002,7 +1002,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L72)* +*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L72)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1019,7 +1019,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L79)* +*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L79)* *__description__*: Returns a hex string representation of the value @@ -1036,7 +1036,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L86)* +*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L86)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1070,7 +1070,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L95)* +*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L95)* *__description__*: Returns the string representation of the value @@ -1085,7 +1085,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L104)* +*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L104)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1142,7 +1142,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L43)* +*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L43)* **Type parameters:** diff --git a/docs/types/classes/_metadata_index_.metadata.md b/docs/types/classes/_metadata_index_.metadata.md index f7abed6dca..9fbb72b99e 100644 --- a/docs/types/classes/_metadata_index_.metadata.md +++ b/docs/types/classes/_metadata_index_.metadata.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/index.ts:39](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/index.ts#L39)* +*Defined in [Metadata/index.ts:39](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/index.ts#L39)* **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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -89,7 +89,7 @@ ___ getcalls(): [Vector](_codec_vector_.vector.md)<[OuterDispatchCall](_metadata_calls_.outerdispatchcall.md)> -*Defined in [Metadata/index.ts:73](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/index.ts#L73)* +*Defined in [Metadata/index.ts:73](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/index.ts#L73)* *__description__*: Wrapped [OuterDispatchCall](_metadata_calls_.outerdispatchcall.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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -117,7 +117,7 @@ ___ getevents(): [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_events_.outereventmetadataevent.md)> -*Defined in [Metadata/index.ts:80](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/index.ts#L80)* +*Defined in [Metadata/index.ts:80](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/index.ts#L80)* *__description__*: Wrapped [OuterEventMetadataEvent](_metadata_events_.outereventmetadataevent.md) @@ -130,7 +130,7 @@ ___ getmodules(): [Vector](_codec_vector_.vector.md)<[RuntimeModuleMetadata](_metadata_modules_.runtimemodulemetadata.md)> -*Defined in [Metadata/index.ts:87](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/index.ts#L87)* +*Defined in [Metadata/index.ts:87](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/index.ts#L87)* *__description__*: Wrapped [RuntimeModuleMetadata](_metadata_modules_.runtimemodulemetadata.md) @@ -232,7 +232,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -253,7 +253,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -272,7 +272,7 @@ ___ ▸ **getUniqTypes**(): `Array`<`string`> -*Defined in [Metadata/index.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/index.ts#L122)* +*Defined in [Metadata/index.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/index.ts#L122)* *__description__*: Helper to retrieve a list of all type that are found, sorted and de-deuplicated @@ -341,7 +341,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -358,7 +358,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -375,7 +375,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -392,7 +392,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -407,7 +407,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -441,7 +441,7 @@ ___ ▸ **decodeMetadata**(value: * `string` | `Uint8Array` | `object`*): `object` | `Uint8Array` -*Defined in [Metadata/index.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/index.ts#L48)* +*Defined in [Metadata/index.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/index.ts#L48)* **Parameters:** @@ -460,7 +460,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_modules_.callmetadata.md b/docs/types/classes/_metadata_modules_.callmetadata.md index 3db140e296..6821c4266e 100644 --- a/docs/types/classes/_metadata_modules_.callmetadata.md +++ b/docs/types/classes/_metadata_modules_.callmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Modules.ts:80](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L80)* +*Defined in [Metadata/Modules.ts:80](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L80)* **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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -100,7 +100,7 @@ ___ getfunctions(): [Vector](_codec_vector_.vector.md)<[FunctionMetadata](_metadata_modules_.functionmetadata.md)> -*Defined in [Metadata/Modules.ts:91](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L91)* +*Defined in [Metadata/Modules.ts:91](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L91)* *__description__*: The functions available as [FunctionMetadata](_metadata_modules_.functionmetadata.md) @@ -113,7 +113,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/Modules.ts:98](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L98)* +*Defined in [Metadata/Modules.ts:98](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L98)* *__description__*: The section name @@ -215,7 +215,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -236,7 +236,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -311,7 +311,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -328,7 +328,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -345,7 +345,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -362,7 +362,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -377,7 +377,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -413,7 +413,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_modules_.functionargumentmetadata.md b/docs/types/classes/_metadata_modules_.functionargumentmetadata.md index c50b0758a3..80a65bb3a4 100644 --- a/docs/types/classes/_metadata_modules_.functionargumentmetadata.md +++ b/docs/types/classes/_metadata_modules_.functionargumentmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Modules.ts:18](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L18)* +*Defined in [Metadata/Modules.ts:18](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L18)* **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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -100,7 +100,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/Modules.ts:29](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L29)* +*Defined in [Metadata/Modules.ts:29](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L29)* *__description__*: The argument name @@ -113,7 +113,7 @@ ___ gettype(): [Type](_type_.type.md) -*Defined in [Metadata/Modules.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L36)* +*Defined in [Metadata/Modules.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L36)* *__description__*: The [Type](_metadata_modules_.functionargumentmetadata.md#type) @@ -215,7 +215,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -236,7 +236,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -311,7 +311,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -328,7 +328,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -345,7 +345,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -362,7 +362,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -377,7 +377,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -413,7 +413,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_modules_.functionmetadata.md b/docs/types/classes/_metadata_modules_.functionmetadata.md index 2c2eb36a4e..1dc8e6f447 100644 --- a/docs/types/classes/_metadata_modules_.functionmetadata.md +++ b/docs/types/classes/_metadata_modules_.functionmetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Modules.ts:41](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L41)* +*Defined in [Metadata/Modules.ts:41](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -85,7 +85,7 @@ ___ getarguments(): [Vector](_codec_vector_.vector.md)<[FunctionArgumentMetadata](_metadata_modules_.functionargumentmetadata.md)> -*Defined in [Metadata/Modules.ts:54](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L54)* +*Defined in [Metadata/Modules.ts:54](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L54)* *__description__*: The [FunctionArgumentMetadata](_metadata_modules_.functionargumentmetadata.md) for arguments @@ -98,7 +98,7 @@ ___ getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> -*Defined in [Metadata/Modules.ts:61](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L61)* +*Defined in [Metadata/Modules.ts:61](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L61)* *__description__*: The [Text](_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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -126,7 +126,7 @@ ___ getid(): [U16](_u16_.u16.md) -*Defined in [Metadata/Modules.ts:68](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L68)* +*Defined in [Metadata/Modules.ts:68](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L68)* *__description__*: The `[sectionIndex, methodIndex]` call id @@ -139,7 +139,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/Modules.ts:75](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L75)* +*Defined in [Metadata/Modules.ts:75](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L75)* *__description__*: The call name @@ -241,7 +241,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -262,7 +262,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -337,7 +337,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -354,7 +354,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -371,7 +371,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -388,7 +388,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -403,7 +403,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -439,7 +439,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_modules_.modulemetadata.md b/docs/types/classes/_metadata_modules_.modulemetadata.md index feb4bb09b5..20d6f5a7d6 100644 --- a/docs/types/classes/_metadata_modules_.modulemetadata.md +++ b/docs/types/classes/_metadata_modules_.modulemetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Modules.ts:103](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L103)* +*Defined in [Metadata/Modules.ts:103](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L103)* **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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -85,7 +85,7 @@ ___ getcall(): [CallMetadata](_metadata_modules_.callmetadata.md) -*Defined in [Metadata/Modules.ts:114](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L114)* +*Defined in [Metadata/Modules.ts:114](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L114)* *__description__*: The calls as [CallMetadata](_metadata_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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -113,7 +113,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/Modules.ts:121](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L121)* +*Defined in [Metadata/Modules.ts:121](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L121)* *__description__*: The name @@ -215,7 +215,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -236,7 +236,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -311,7 +311,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -328,7 +328,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -345,7 +345,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -362,7 +362,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -377,7 +377,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -413,7 +413,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_modules_.runtimemodulemetadata.md b/docs/types/classes/_metadata_modules_.runtimemodulemetadata.md index 20b2ea6bf8..cf6753b42c 100644 --- a/docs/types/classes/_metadata_modules_.runtimemodulemetadata.md +++ b/docs/types/classes/_metadata_modules_.runtimemodulemetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Modules.ts:302](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L302)* +*Defined in [Metadata/Modules.ts:302](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L302)* **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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -100,7 +100,7 @@ ___ getmodule(): [ModuleMetadata](_metadata_modules_.modulemetadata.md) -*Defined in [Metadata/Modules.ts:314](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L314)* +*Defined in [Metadata/Modules.ts:314](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L314)* *__description__*: The [ModuleMetadata](_metadata_modules_.modulemetadata.md) @@ -113,7 +113,7 @@ ___ getprefix(): [Text](_text_.text.md) -*Defined in [Metadata/Modules.ts:321](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L321)* +*Defined in [Metadata/Modules.ts:321](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L321)* *__description__*: The prefix @@ -126,7 +126,7 @@ ___ getstorage(): [Option](_codec_option_.option.md)<[StorageMetadata](_metadata_modules_.storagemetadata.md)> -*Defined in [Metadata/Modules.ts:328](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L328)* +*Defined in [Metadata/Modules.ts:328](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L328)* *__description__*: The optional [StorageMetadata](_metadata_modules_.storagemetadata.md) @@ -228,7 +228,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -249,7 +249,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -324,7 +324,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -341,7 +341,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -358,7 +358,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -375,7 +375,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -390,7 +390,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -426,7 +426,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_modules_.storagefunctionmetadata.md b/docs/types/classes/_metadata_modules_.storagefunctionmetadata.md index 6f63314287..25b658f6ad 100644 --- a/docs/types/classes/_metadata_modules_.storagefunctionmetadata.md +++ b/docs/types/classes/_metadata_modules_.storagefunctionmetadata.md @@ -26,7 +26,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Modules.ts:202](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L202)* +*Defined in [Metadata/Modules.ts:202](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L202)* **Parameters:** @@ -73,7 +73,7 @@ getType(): `E` *Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* -*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -86,7 +86,7 @@ ___ getdefault(): `T` -*Defined in [Metadata/Modules.ts:246](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L246)* +*Defined in [Metadata/Modules.ts:246](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L246)* *__description__*: The default value of the storage function @@ -99,7 +99,7 @@ ___ getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)> -*Defined in [Metadata/Modules.ts:253](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L253)* +*Defined in [Metadata/Modules.ts:253](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L253)* *__description__*: The [Text](_text_.text.md) documentation @@ -114,7 +114,7 @@ getencodedLength(): `number` *Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* -*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -127,7 +127,7 @@ ___ getmodifier(): [StorageFunctionModifier](_metadata_modules_.storagefunctionmodifier.md) -*Defined in [Metadata/Modules.ts:267](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L267)* +*Defined in [Metadata/Modules.ts:267](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L267)* *__description__*: The modifier @@ -140,7 +140,7 @@ ___ getname(): [Text](_text_.text.md) -*Defined in [Metadata/Modules.ts:260](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L260)* +*Defined in [Metadata/Modules.ts:260](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L260)* *__description__*: The key name @@ -153,7 +153,7 @@ ___ gettype(): [StorageFunctionType](_metadata_modules_.storagefunctiontype.md) -*Defined in [Metadata/Modules.ts:274](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L274)* +*Defined in [Metadata/Modules.ts:274](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L274)* *__description__*: The [StorageFunctionType](_metadata_modules_.storagefunctiontype.md) @@ -255,7 +255,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -276,7 +276,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -351,7 +351,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -368,7 +368,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -385,7 +385,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -402,7 +402,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__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:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__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:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_modules_.storagefunctionmodifier.md b/docs/types/classes/_metadata_modules_.storagefunctionmodifier.md index 6114c0dd7e..4c7b831c10 100644 --- a/docs/types/classes/_metadata_modules_.storagefunctionmodifier.md +++ b/docs/types/classes/_metadata_modules_.storagefunctionmodifier.md @@ -20,7 +20,7 @@ *Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* -*Defined in [Metadata/Modules.ts:126](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L126)* +*Defined in [Metadata/Modules.ts:126](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L126)* **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/e79c6d8/packages/types/src/codec/Enum.ts#L64)* +*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -62,7 +62,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toHex](_codec_enum_.enum.md#tohex)* -*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L71)* +*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L71)* *__description__*: Returns a hex string representation of the value @@ -79,7 +79,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toJSON](_codec_enum_.enum.md#tojson)* -*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L78)* +*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L78)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -94,7 +94,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* -*Defined in [codec/Enum.ts:85](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L85)* +*Defined in [codec/Enum.ts:85](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L85)* *__description__*: Returns the number representation for the value @@ -111,7 +111,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toString](_codec_enum_.enum.md#tostring)* -*Defined in [codec/Enum.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L92)* +*Defined in [codec/Enum.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L92)* *__description__*: Returns the string representation of the value @@ -126,7 +126,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toU8a](_codec_enum_.enum.md#tou8a)* -*Defined in [codec/Enum.ts:100](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L100)* +*Defined in [codec/Enum.ts:100](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L100)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -147,7 +147,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[decodeEnum](_codec_enum_.enum.md#decodeenum)* -*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L47)* +*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L47)* **Parameters:** diff --git a/docs/types/classes/_metadata_modules_.storagefunctiontype.md b/docs/types/classes/_metadata_modules_.storagefunctiontype.md index f24c1d15a8..f64a180149 100644 --- a/docs/types/classes/_metadata_modules_.storagefunctiontype.md +++ b/docs/types/classes/_metadata_modules_.storagefunctiontype.md @@ -20,7 +20,7 @@ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* -*Defined in [Metadata/Modules.ts:155](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L155)* +*Defined in [Metadata/Modules.ts:155](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L155)* **Parameters:** @@ -41,7 +41,7 @@ ___ getasMap(): [StorageFunctionType$Map](_metadata_modules_.storagefunctiontype_map.md) -*Defined in [Metadata/Modules.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L173)* +*Defined in [Metadata/Modules.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L173)* *__description__*: The value as a mapped value @@ -54,7 +54,7 @@ ___ getasType(): [Type](_type_.type.md) -*Defined in [Metadata/Modules.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L180)* +*Defined in [Metadata/Modules.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L180)* *__description__*: The value as a \[\[Type\]\] value @@ -69,7 +69,7 @@ getencodedLength(): `number` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* -*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/EnumType.ts#L97)* +*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/EnumType.ts#L97)* *__description__*: The length of the value when encoded as a Uint8Array @@ -82,7 +82,7 @@ ___ getisMap(): `boolean` -*Defined in [Metadata/Modules.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L166)* +*Defined in [Metadata/Modules.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L166)* *__description__*: `true` if the storage entry is a map @@ -97,7 +97,7 @@ getisNone(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* -*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/EnumType.ts#L104)* +*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/EnumType.ts#L104)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type @@ -112,7 +112,7 @@ getisNull(): `boolean` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* -*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/EnumType.ts#L111)* +*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/EnumType.ts#L111)* *__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone) @@ -127,7 +127,7 @@ gettype(): `string` *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* -*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/EnumType.ts#L118)* +*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/EnumType.ts#L118)* *__description__*: The name of the type this enum value represents @@ -142,7 +142,7 @@ getvalue(): [Codec](../interfaces/_types_.codec.md) *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* -*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/EnumType.ts#L125)* +*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/EnumType.ts#L125)* *__description__*: The value of the enum @@ -162,7 +162,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* -*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/EnumType.ts#L132)* +*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/EnumType.ts#L132)* *__description__*: Returns a hex string representation of the value @@ -179,7 +179,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* -*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/EnumType.ts#L139)* +*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/EnumType.ts#L139)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -194,7 +194,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* -*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/EnumType.ts#L146)* +*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/EnumType.ts#L146)* *__description__*: Returns the number representation for the value @@ -211,7 +211,7 @@ ___ *Overrides [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* -*Defined in [Metadata/Modules.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L187)* +*Defined in [Metadata/Modules.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L187)* *__description__*: Returns the string representation of the value @@ -226,7 +226,7 @@ ___ *Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* -*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/EnumType.ts#L161)* +*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/EnumType.ts#L161)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_metadata_modules_.storagefunctiontype_map.md b/docs/types/classes/_metadata_modules_.storagefunctiontype_map.md index 7b63345320..3aae2f6ba7 100644 --- a/docs/types/classes/_metadata_modules_.storagefunctiontype_map.md +++ b/docs/types/classes/_metadata_modules_.storagefunctiontype_map.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Modules.ts:132](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L132)* +*Defined in [Metadata/Modules.ts:132](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L132)* **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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -100,7 +100,7 @@ ___ getkey(): [Type](_type_.type.md) -*Defined in [Metadata/Modules.ts:143](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L143)* +*Defined in [Metadata/Modules.ts:143](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L143)* *__description__*: The mapped key as [Type](_metadata_modules_.storagefunctiontype_map.md#type) @@ -113,7 +113,7 @@ ___ getvalue(): [Type](_type_.type.md) -*Defined in [Metadata/Modules.ts:150](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L150)* +*Defined in [Metadata/Modules.ts:150](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L150)* *__description__*: The mapped value as [Type](_metadata_modules_.storagefunctiontype_map.md#type) @@ -215,7 +215,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -236,7 +236,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -311,7 +311,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -328,7 +328,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -345,7 +345,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -362,7 +362,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -377,7 +377,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -413,7 +413,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_metadata_modules_.storagemetadata.md b/docs/types/classes/_metadata_modules_.storagemetadata.md index b48e6f042c..52090ca52b 100644 --- a/docs/types/classes/_metadata_modules_.storagemetadata.md +++ b/docs/types/classes/_metadata_modules_.storagemetadata.md @@ -25,7 +25,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Metadata/Modules.ts:279](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L279)* +*Defined in [Metadata/Modules.ts:279](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L279)* **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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -100,7 +100,7 @@ ___ getfunctions(): [Vector](_codec_vector_.vector.md)<[StorageFunctionMetadata](_metadata_modules_.storagefunctionmetadata.md)> -*Defined in [Metadata/Modules.ts:290](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L290)* +*Defined in [Metadata/Modules.ts:290](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L290)* *__description__*: The [StorageFunctionMetadata](_metadata_modules_.storagefunctionmetadata.md) for the section @@ -113,7 +113,7 @@ ___ getprefix(): [Text](_text_.text.md) -*Defined in [Metadata/Modules.ts:297](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Metadata/Modules.ts#L297)* +*Defined in [Metadata/Modules.ts:297](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Metadata/Modules.ts#L297)* *__description__*: The section prefix @@ -215,7 +215,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -236,7 +236,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -311,7 +311,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -328,7 +328,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -345,7 +345,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -362,7 +362,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -377,7 +377,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -413,7 +413,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_method_.method.html b/docs/types/classes/_method_.method.html index 3f56fc7849..ad4bdd7403 100644 --- a/docs/types/classes/_method_.method.html +++ b/docs/types/classes/_method_.method.html @@ -1980,7 +1980,7 @@

constructor

⊕ new Method(value: any, meta?: FunctionMetadata): Method

Overrides Struct.constructor

-

Defined in Method.ts:70

+

Defined in Method.ts:70

Parameters:

@@ -2020,35 +2020,35 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


args

getargs(): Array<Codec>

-

Defined in Method.ts:185

+

Defined in Method.ts:185

description: The arguments for the function call

Returns: Array<Codec>


argsDef

getargsDef(): ArgsDef

-

Defined in Method.ts:193

+

Defined in Method.ts:193

description: Thge argument defintions

Returns: ArgsDef


callIndex

getcallIndex(): Uint8Array

-

Defined in Method.ts:200

+

Defined in Method.ts:200

description: The encoded [sectionIndex, methodIndex] identifier

Returns: Uint8Array


data

getdata(): Uint8Array

-

Defined in Method.ts:207

+

Defined in Method.ts:207

description: The encoded data

Returns: Uint8Array


@@ -2056,21 +2056,21 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


hasOrigin

gethasOrigin(): boolean

-

Defined in Method.ts:214

+

Defined in Method.ts:214

description: true if the Origin type is on the method (extrinsic method)

Returns: boolean


meta

getmeta(): FunctionMetadata

-

Defined in Method.ts:223

+

Defined in Method.ts:223

description: The FunctionMetadata

Returns: FunctionMetadata


@@ -2151,7 +2151,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

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

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

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

Parameters:

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

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


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

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2273,7 +2273,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

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

Returns: any


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

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2290,7 +2290,7 @@

toU8a

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

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

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

Parameters:

@@ -2322,7 +2322,7 @@

<Static> filterOrigin

▸ filterOrigin(meta?: FunctionMetadata): Array<FunctionArgumentMetadata>

-

Defined in Method.ts:133

+

Defined in Method.ts:133

Parameters:

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

<Static> findFunction

▸ findFunction(callIndex: Uint8Array): MethodFunction

-

Defined in Method.ts:149

+

Defined in Method.ts:149

Parameters:

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

<Static> injectMethods

▸ injectMethods(moduleMethods: ModulesWithMethods): void

-

Defined in Method.ts:174

+

Defined in Method.ts:174

Parameters:

@@ -2386,7 +2386,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2449,7 +2449,7 @@ diff --git a/docs/types/classes/_method_.method.md b/docs/types/classes/_method_.method.md index bd0f177a09..64d226ffca 100644 --- a/docs/types/classes/_method_.method.md +++ b/docs/types/classes/_method_.method.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Method.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L70)* +*Defined in [Method.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -92,7 +92,7 @@ ___ getargs(): `Array`<[Codec](../interfaces/_types_.codec.md)> -*Defined in [Method.ts:185](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L185)* +*Defined in [Method.ts:185](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L185)* *__description__*: The arguments for the function call @@ -105,7 +105,7 @@ ___ getargsDef(): `ArgsDef` -*Defined in [Method.ts:193](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L193)* +*Defined in [Method.ts:193](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L193)* *__description__*: Thge argument defintions @@ -118,7 +118,7 @@ ___ getcallIndex(): `Uint8Array` -*Defined in [Method.ts:200](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L200)* +*Defined in [Method.ts:200](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L200)* *__description__*: The encoded `[sectionIndex, methodIndex]` identifier @@ -131,7 +131,7 @@ ___ getdata(): `Uint8Array` -*Defined in [Method.ts:207](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L207)* +*Defined in [Method.ts:207](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L207)* *__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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -159,7 +159,7 @@ ___ gethasOrigin(): `boolean` -*Defined in [Method.ts:214](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L214)* +*Defined in [Method.ts:214](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L214)* *__description__*: `true` if the `Origin` type is on the method (extrinsic method) @@ -172,7 +172,7 @@ ___ getmeta(): [FunctionMetadata](_metadata_modules_.functionmetadata.md) -*Defined in [Method.ts:223](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L223)* +*Defined in [Method.ts:223](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L223)* *__description__*: The [FunctionMetadata](_metadata_modules_.functionmetadata.md) @@ -274,7 +274,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -295,7 +295,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -370,7 +370,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -387,7 +387,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -404,7 +404,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -421,7 +421,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -436,7 +436,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -470,7 +470,7 @@ ___ ▸ **filterOrigin**(meta?: *[FunctionMetadata](_metadata_modules_.functionmetadata.md)*): `Array`<[FunctionArgumentMetadata](_metadata_modules_.functionargumentmetadata.md)> -*Defined in [Method.ts:133](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L133)* +*Defined in [Method.ts:133](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L133)* **Parameters:** @@ -487,7 +487,7 @@ ___ ▸ **findFunction**(callIndex: *`Uint8Array`*): [MethodFunction](../interfaces/_method_.methodfunction.md) -*Defined in [Method.ts:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L149)* +*Defined in [Method.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L149)* **Parameters:** @@ -504,7 +504,7 @@ ___ ▸ **injectMethods**(moduleMethods: *[ModulesWithMethods](../interfaces/_method_.moduleswithmethods.md)*): `void` -*Defined in [Method.ts:174](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L174)* +*Defined in [Method.ts:174](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L174)* **Parameters:** @@ -523,7 +523,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_method_.methodindex.html b/docs/types/classes/_method_.methodindex.html index b7f908093e..26a7ade730 100644 --- a/docs/types/classes/_method_.methodindex.html +++ b/docs/types/classes/_method_.methodindex.html @@ -1976,7 +1976,7 @@

constructor

⊕ new MethodIndex(value?: AnyU8a): MethodIndex

Overrides U8aFixed.constructor

-

Defined in Method.ts:57

+

Defined in Method.ts:57

Parameters:

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


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

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2059,7 +2059,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2726,7 +2726,7 @@

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

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

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

Parameters:

@@ -2757,7 +2757,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2766,7 +2766,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

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

Returns: any


@@ -2784,7 +2784,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2792,7 +2792,7 @@

toU8a

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

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

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

Parameters:

@@ -2864,7 +2864,7 @@ diff --git a/docs/types/classes/_method_.methodindex.md b/docs/types/classes/_method_.methodindex.md index e5a0ca0007..d66c5246f9 100644 --- a/docs/types/classes/_method_.methodindex.md +++ b/docs/types/classes/_method_.methodindex.md @@ -27,7 +27,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [Method.ts:57](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L57)* +*Defined in [Method.ts:57](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/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/e79c6d8/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -132,7 +132,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -163,7 +163,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -689,7 +689,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -713,7 +713,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -730,7 +730,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -764,7 +764,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -779,7 +779,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_misbehaviorreport_.bftatreport.html b/docs/types/classes/_misbehaviorreport_.bftatreport.html index 127a0734b7..b1d6caffd6 100644 --- a/docs/types/classes/_misbehaviorreport_.bftatreport.html +++ b/docs/types/classes/_misbehaviorreport_.bftatreport.html @@ -1982,7 +1982,7 @@

constructor

⊕ new BftAtReport(value?: BftAtReportValue | Uint8Array): BftAtReport

Overrides Struct.constructor

-

Defined in MisbehaviorReport.ts:33

+

Defined in MisbehaviorReport.ts:33

Parameters:

@@ -2018,21 +2018,21 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


a

geta(): BftHashSignature

-

Defined in MisbehaviorReport.ts:45

+

Defined in MisbehaviorReport.ts:45

description: The first report BftHashSignature

Returns: BftHashSignature


b

getb(): BftHashSignature

-

Defined in MisbehaviorReport.ts:52

+

Defined in MisbehaviorReport.ts:52

description: The second report BftHashSignature

Returns: BftHashSignature


@@ -2040,14 +2040,14 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


round

getround(): U32

-

Defined in MisbehaviorReport.ts:59

+

Defined in MisbehaviorReport.ts:59

description: The round this report applies to as U32

Returns: U32


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

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2153,7 +2153,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

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

Parameters:

@@ -2232,7 +2232,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


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

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2250,7 +2250,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

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

Returns: any


@@ -2259,7 +2259,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2267,7 +2267,7 @@

toU8a

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

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

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

Parameters:

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

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2363,7 +2363,7 @@ diff --git a/docs/types/classes/_misbehaviorreport_.bftatreport.md b/docs/types/classes/_misbehaviorreport_.bftatreport.md index 7c1b1f26a0..acbabff306 100644 --- a/docs/types/classes/_misbehaviorreport_.bftatreport.md +++ b/docs/types/classes/_misbehaviorreport_.bftatreport.md @@ -35,7 +35,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L33)* +*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -95,7 +95,7 @@ ___ geta(): [BftHashSignature](_bft_.bfthashsignature.md) -*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L45)* +*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/MisbehaviorReport.ts#L45)* *__description__*: The first report [BftHashSignature](_bft_.bfthashsignature.md) @@ -108,7 +108,7 @@ ___ getb(): [BftHashSignature](_bft_.bfthashsignature.md) -*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L52)* +*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/MisbehaviorReport.ts#L52)* *__description__*: The second report [BftHashSignature](_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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -136,7 +136,7 @@ ___ getround(): [U32](_u32_.u32.md) -*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L59)* +*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/MisbehaviorReport.ts#L59)* *__description__*: The round this report applies to as [U32](_u32_.u32.md) @@ -238,7 +238,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -259,7 +259,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -334,7 +334,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -351,7 +351,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -368,7 +368,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -385,7 +385,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -400,7 +400,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -436,7 +436,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.bftdoublecommit.html b/docs/types/classes/_misbehaviorreport_.bftdoublecommit.html index 6f7e612b3b..787b11ba8a 100644 --- a/docs/types/classes/_misbehaviorreport_.bftdoublecommit.html +++ b/docs/types/classes/_misbehaviorreport_.bftdoublecommit.html @@ -1980,7 +1980,7 @@

⊕ new BftDoubleCommit(value?: BftAtReportValue | Uint8Array): BftDoubleCommit

Inherited from BftAtReport.constructor

Overrides Struct.constructor

-

Defined in MisbehaviorReport.ts:33

+

Defined in MisbehaviorReport.ts:33

Parameters:

@@ -2016,7 +2016,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2024,7 +2024,7 @@

a

geta(): BftHashSignature

Inherited from BftAtReport.a

-

Defined in MisbehaviorReport.ts:45

+

Defined in MisbehaviorReport.ts:45

description: The first report BftHashSignature

Returns: BftHashSignature


@@ -2032,7 +2032,7 @@

b

getb(): BftHashSignature

Inherited from BftAtReport.b

-

Defined in MisbehaviorReport.ts:52

+

Defined in MisbehaviorReport.ts:52

description: The second report BftHashSignature

Returns: BftHashSignature


@@ -2040,7 +2040,7 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


@@ -2048,7 +2048,7 @@

round

getround(): U32

Inherited from BftAtReport.round

-

Defined in MisbehaviorReport.ts:59

+

Defined in MisbehaviorReport.ts:59

description: The round this report applies to as U32

Returns: U32


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

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

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

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

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

Parameters:

@@ -2233,7 +2233,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


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

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2251,7 +2251,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

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

Returns: any


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

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


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

toU8a

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

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

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

Parameters:

@@ -2301,7 +2301,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2364,7 +2364,7 @@ diff --git a/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md b/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md index 6a3a70415e..96141a8067 100644 --- a/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md +++ b/docs/types/classes/_misbehaviorreport_.bftdoublecommit.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L33)* +*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -93,7 +93,7 @@ geta(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[a](_misbehaviorreport_.bftatreport.md#a)* -*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L45)* +*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/MisbehaviorReport.ts#L45)* *__description__*: The first report [BftHashSignature](_bft_.bfthashsignature.md) @@ -108,7 +108,7 @@ getb(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[b](_misbehaviorreport_.bftatreport.md#b)* -*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L52)* +*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/MisbehaviorReport.ts#L52)* *__description__*: The second report [BftHashSignature](_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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -138,7 +138,7 @@ getround(): [U32](_u32_.u32.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[round](_misbehaviorreport_.bftatreport.md#round)* -*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L59)* +*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/MisbehaviorReport.ts#L59)* *__description__*: The round this report applies to as [U32](_u32_.u32.md) @@ -240,7 +240,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -261,7 +261,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -336,7 +336,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -353,7 +353,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -370,7 +370,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -387,7 +387,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -402,7 +402,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -438,7 +438,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.html b/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.html index 40cc1e7615..0f7204dfba 100644 --- a/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.html +++ b/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.html @@ -1980,7 +1980,7 @@

⊕ new BftDoublePrepare(value?: BftAtReportValue | Uint8Array): BftDoublePrepare

Inherited from BftAtReport.constructor

Overrides Struct.constructor

-

Defined in MisbehaviorReport.ts:33

+

Defined in MisbehaviorReport.ts:33

Parameters:

@@ -2016,7 +2016,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2024,7 +2024,7 @@

a

geta(): BftHashSignature

Inherited from BftAtReport.a

-

Defined in MisbehaviorReport.ts:45

+

Defined in MisbehaviorReport.ts:45

description: The first report BftHashSignature

Returns: BftHashSignature


@@ -2032,7 +2032,7 @@

b

getb(): BftHashSignature

Inherited from BftAtReport.b

-

Defined in MisbehaviorReport.ts:52

+

Defined in MisbehaviorReport.ts:52

description: The second report BftHashSignature

Returns: BftHashSignature


@@ -2040,7 +2040,7 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


@@ -2048,7 +2048,7 @@

round

getround(): U32

Inherited from BftAtReport.round

-

Defined in MisbehaviorReport.ts:59

+

Defined in MisbehaviorReport.ts:59

description: The round this report applies to as U32

Returns: U32


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

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

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

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

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

Parameters:

@@ -2233,7 +2233,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


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

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2251,7 +2251,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

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

Returns: any


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

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


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

toU8a

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

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

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

Parameters:

@@ -2301,7 +2301,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2364,7 +2364,7 @@ diff --git a/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md b/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md index 3528995f66..f51322dea1 100644 --- a/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md +++ b/docs/types/classes/_misbehaviorreport_.bftdoubleprepare.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L33)* +*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -93,7 +93,7 @@ geta(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[a](_misbehaviorreport_.bftatreport.md#a)* -*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L45)* +*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/MisbehaviorReport.ts#L45)* *__description__*: The first report [BftHashSignature](_bft_.bfthashsignature.md) @@ -108,7 +108,7 @@ getb(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[b](_misbehaviorreport_.bftatreport.md#b)* -*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L52)* +*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/MisbehaviorReport.ts#L52)* *__description__*: The second report [BftHashSignature](_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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -138,7 +138,7 @@ getround(): [U32](_u32_.u32.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[round](_misbehaviorreport_.bftatreport.md#round)* -*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L59)* +*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/MisbehaviorReport.ts#L59)* *__description__*: The round this report applies to as [U32](_u32_.u32.md) @@ -240,7 +240,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -261,7 +261,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -336,7 +336,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -353,7 +353,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -370,7 +370,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -387,7 +387,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -402,7 +402,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -438,7 +438,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.bftdoublepropose.html b/docs/types/classes/_misbehaviorreport_.bftdoublepropose.html index b1dc495887..99cdc7305f 100644 --- a/docs/types/classes/_misbehaviorreport_.bftdoublepropose.html +++ b/docs/types/classes/_misbehaviorreport_.bftdoublepropose.html @@ -1980,7 +1980,7 @@

⊕ new BftDoublePropose(value?: BftAtReportValue | Uint8Array): BftDoublePropose

Inherited from BftAtReport.constructor

Overrides Struct.constructor

-

Defined in MisbehaviorReport.ts:33

+

Defined in MisbehaviorReport.ts:33

Parameters:

@@ -2016,7 +2016,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2024,7 +2024,7 @@

a

geta(): BftHashSignature

Inherited from BftAtReport.a

-

Defined in MisbehaviorReport.ts:45

+

Defined in MisbehaviorReport.ts:45

description: The first report BftHashSignature

Returns: BftHashSignature


@@ -2032,7 +2032,7 @@

b

getb(): BftHashSignature

Inherited from BftAtReport.b

-

Defined in MisbehaviorReport.ts:52

+

Defined in MisbehaviorReport.ts:52

description: The second report BftHashSignature

Returns: BftHashSignature


@@ -2040,7 +2040,7 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


@@ -2048,7 +2048,7 @@

round

getround(): U32

Inherited from BftAtReport.round

-

Defined in MisbehaviorReport.ts:59

+

Defined in MisbehaviorReport.ts:59

description: The round this report applies to as U32

Returns: U32


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

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

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

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

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

Parameters:

@@ -2233,7 +2233,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


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

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2251,7 +2251,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

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

Returns: any


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

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


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

toU8a

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

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

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

Parameters:

@@ -2301,7 +2301,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2364,7 +2364,7 @@ diff --git a/docs/types/classes/_misbehaviorreport_.bftdoublepropose.md b/docs/types/classes/_misbehaviorreport_.bftdoublepropose.md index 4e411b1c90..5f61584d06 100644 --- a/docs/types/classes/_misbehaviorreport_.bftdoublepropose.md +++ b/docs/types/classes/_misbehaviorreport_.bftdoublepropose.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L33)* +*Defined in [MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -93,7 +93,7 @@ geta(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[a](_misbehaviorreport_.bftatreport.md#a)* -*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L45)* +*Defined in [MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/MisbehaviorReport.ts#L45)* *__description__*: The first report [BftHashSignature](_bft_.bfthashsignature.md) @@ -108,7 +108,7 @@ getb(): [BftHashSignature](_bft_.bfthashsignature.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[b](_misbehaviorreport_.bftatreport.md#b)* -*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L52)* +*Defined in [MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/MisbehaviorReport.ts#L52)* *__description__*: The second report [BftHashSignature](_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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -138,7 +138,7 @@ getround(): [U32](_u32_.u32.md) *Inherited from [BftAtReport](_misbehaviorreport_.bftatreport.md).[round](_misbehaviorreport_.bftatreport.md#round)* -*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L59)* +*Defined in [MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/MisbehaviorReport.ts#L59)* *__description__*: The round this report applies to as [U32](_u32_.u32.md) @@ -240,7 +240,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -261,7 +261,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -336,7 +336,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -353,7 +353,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -370,7 +370,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -387,7 +387,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -402,7 +402,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -438,7 +438,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.html b/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.html index b1ab474802..b115f29001 100644 --- a/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.html +++ b/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.html @@ -1979,7 +1979,7 @@

constructor

⊕ new BftProposeOutOfTurn(value?: BftAtReportValue | Uint8Array): BftProposeOutOfTurn

Overrides Struct.constructor

-

Defined in MisbehaviorReport.ts:69

+

Defined in MisbehaviorReport.ts:69

Parameters:

@@ -2015,14 +2015,14 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


a

geta(): BftHashSignature

-

Defined in MisbehaviorReport.ts:80

+

Defined in MisbehaviorReport.ts:80

description: The BftHashSignature the report applies to

Returns: BftHashSignature


@@ -2030,14 +2030,14 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


round

getround(): U32

-

Defined in MisbehaviorReport.ts:87

+

Defined in MisbehaviorReport.ts:87

description: The round as [[u32]]

Returns: U32


@@ -2118,7 +2118,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

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

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

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

Parameters:

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

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


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

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


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

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

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

Returns: any


@@ -2249,7 +2249,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2257,7 +2257,7 @@

toU8a

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

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

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

Parameters:

@@ -2290,7 +2290,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2353,7 +2353,7 @@ diff --git a/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.md b/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.md index ab2619be1e..89ee67b7bf 100644 --- a/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.md +++ b/docs/types/classes/_misbehaviorreport_.bftproposeoutofturn.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:69](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L69)* +*Defined in [MisbehaviorReport.ts:69](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -89,7 +89,7 @@ ___ geta(): [BftHashSignature](_bft_.bfthashsignature.md) -*Defined in [MisbehaviorReport.ts:80](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L80)* +*Defined in [MisbehaviorReport.ts:80](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/MisbehaviorReport.ts#L80)* *__description__*: The [BftHashSignature](_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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -117,7 +117,7 @@ ___ getround(): [U32](_u32_.u32.md) -*Defined in [MisbehaviorReport.ts:87](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L87)* +*Defined in [MisbehaviorReport.ts:87](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/MisbehaviorReport.ts#L87)* *__description__*: The round as \[\[u32\]\] @@ -219,7 +219,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -240,7 +240,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -315,7 +315,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -332,7 +332,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -381,7 +381,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -417,7 +417,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_misbehaviorreport_.misbehaviorkind.html b/docs/types/classes/_misbehaviorreport_.misbehaviorkind.html index b4692e714a..71474c3757 100644 --- a/docs/types/classes/_misbehaviorreport_.misbehaviorkind.html +++ b/docs/types/classes/_misbehaviorreport_.misbehaviorkind.html @@ -1974,7 +1974,7 @@

constructor

⊕ new MisbehaviorKind(value?: BftAtReportValue | Uint8Array, index?: undefined | number): MisbehaviorKind

Overrides EnumType.constructor

-

Defined in MisbehaviorReport.ts:121

+

Defined in MisbehaviorReport.ts:121

Parameters:

@@ -2001,7 +2001,7 @@

encodedLength

getencodedLength(): number

Inherited from EnumType.encodedLength

-

Defined in codec/EnumType.ts:97

+

Defined in codec/EnumType.ts:97

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

Returns: number


@@ -2009,7 +2009,7 @@

isNone

getisNone(): boolean

Inherited from EnumType.isNone

-

Defined in codec/EnumType.ts:104

+

Defined in codec/EnumType.ts:104

description: Checks if the Enum points to a Null type

Returns: boolean


@@ -2017,7 +2017,7 @@

isNull

getisNull(): boolean

Inherited from EnumType.isNull

-

Defined in codec/EnumType.ts:111

+

Defined in codec/EnumType.ts:111

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

Returns: boolean


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

type

gettype(): string

Inherited from EnumType.type

-

Defined in codec/EnumType.ts:118

+

Defined in codec/EnumType.ts:118

description: The name of the type this enum value represents

Returns: string


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

value

getvalue(): Codec

Inherited from EnumType.value

-

Defined in codec/EnumType.ts:125

+

Defined in codec/EnumType.ts:125

description: The value of the enum

Returns: Codec


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

▸ toHex(): string

Implementation of Codec.toHex

Inherited from EnumType.toHex

-

Defined in codec/EnumType.ts:132

+

Defined in codec/EnumType.ts:132

description: Returns a hex string representation of the value

Returns: string


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

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from EnumType.toJSON

-

Defined in codec/EnumType.ts:139

+

Defined in codec/EnumType.ts:139

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

Returns: any


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

toNumber

▸ toNumber(): number

Inherited from EnumType.toNumber

-

Defined in codec/EnumType.ts:146

+

Defined in codec/EnumType.ts:146

description: Returns the number representation for the value

Returns: number


@@ -2069,7 +2069,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from EnumType.toString

-

Defined in codec/EnumType.ts:153

+

Defined in codec/EnumType.ts:153

description: Returns the string representation of the value

Returns: string


@@ -2077,7 +2077,7 @@

toU8a

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

Inherited from EnumType.toU8a

-

Defined in codec/EnumType.ts:161

+

Defined in codec/EnumType.ts:161

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

Parameters:

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

constructor

⊕ new MisbehaviorReport(value?: MisbehaviorReportValue | Uint8Array): MisbehaviorReport

Overrides Struct.constructor

-

Defined in MisbehaviorReport.ts:144

+

Defined in MisbehaviorReport.ts:144

Parameters:

@@ -2015,7 +2015,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2023,35 +2023,35 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


misbehavior

getmisbehavior(): MisbehaviorKind

-

Defined in MisbehaviorReport.ts:157

+

Defined in MisbehaviorReport.ts:157

description: The MisbehaviorKind

Returns: MisbehaviorKind


parentHash

getparentHash(): Hash

-

Defined in MisbehaviorReport.ts:164

+

Defined in MisbehaviorReport.ts:164

description: The Hash of the parent block

Returns: Hash


parentNumber

getparentNumber(): BlockNumber

-

Defined in MisbehaviorReport.ts:171

+

Defined in MisbehaviorReport.ts:171

description: The BlockNumber of the parent

Returns: BlockNumber


target

gettarget(): AuthorityId

-

Defined in MisbehaviorReport.ts:178

+

Defined in MisbehaviorReport.ts:178

description: The authorityId the report applies to

Returns: AuthorityId


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

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

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

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

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

Parameters:

@@ -2236,7 +2236,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


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

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


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

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

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

Returns: any


@@ -2263,7 +2263,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


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

toU8a

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

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

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

Parameters:

@@ -2304,7 +2304,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2367,7 +2367,7 @@ diff --git a/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md b/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md index 6fb823b54f..2e5d17b71c 100644 --- a/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md +++ b/docs/types/classes/_misbehaviorreport_.misbehaviorreport.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [MisbehaviorReport.ts:144](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L144)* +*Defined in [MisbehaviorReport.ts:144](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/MisbehaviorReport.ts#L144)* **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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -104,7 +104,7 @@ ___ getmisbehavior(): [MisbehaviorKind](_misbehaviorreport_.misbehaviorkind.md) -*Defined in [MisbehaviorReport.ts:157](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L157)* +*Defined in [MisbehaviorReport.ts:157](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/MisbehaviorReport.ts#L157)* *__description__*: The [MisbehaviorKind](_misbehaviorreport_.misbehaviorkind.md) @@ -117,7 +117,7 @@ ___ getparentHash(): [Hash](_hash_.hash.md) -*Defined in [MisbehaviorReport.ts:164](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L164)* +*Defined in [MisbehaviorReport.ts:164](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/MisbehaviorReport.ts#L164)* *__description__*: The [Hash](_hash_.hash.md) of the parent block @@ -130,7 +130,7 @@ ___ getparentNumber(): [BlockNumber](_blocknumber_.blocknumber.md) -*Defined in [MisbehaviorReport.ts:171](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L171)* +*Defined in [MisbehaviorReport.ts:171](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/MisbehaviorReport.ts#L171)* *__description__*: The [BlockNumber](_blocknumber_.blocknumber.md) of the parent @@ -143,7 +143,7 @@ ___ gettarget(): [AuthorityId](_authorityid_.authorityid.md) -*Defined in [MisbehaviorReport.ts:178](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/MisbehaviorReport.ts#L178)* +*Defined in [MisbehaviorReport.ts:178](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/MisbehaviorReport.ts#L178)* *__description__*: The [authorityId](_bft_.bftauthoritysignature.md#authorityid) the report applies to @@ -245,7 +245,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__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:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -341,7 +341,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -358,7 +358,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -375,7 +375,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -392,7 +392,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -407,7 +407,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -443,7 +443,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_moment_.moment.html b/docs/types/classes/_moment_.moment.html index 17e6680c00..1b5801656c 100644 --- a/docs/types/classes/_moment_.moment.html +++ b/docs/types/classes/_moment_.moment.html @@ -1973,7 +1973,7 @@

constructor

⊕ new Moment(value?: Moment | Date | AnyNumber): Moment

-

Defined in Moment.ts:24

+

Defined in Moment.ts:24

Parameters:

@@ -2003,7 +2003,7 @@

encodedLength

getencodedLength(): number

-

Defined in Moment.ts:51

+

Defined in Moment.ts:51

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

Returns: number


@@ -2011,14 +2011,14 @@

bitLength

▸ bitLength(): UIntBitLength

-

Defined in Moment.ts:58

+

Defined in Moment.ts:58

description: Returns the number of bits in the value

Returns: UIntBitLength


toBn

▸ toBn(): BN

-

Defined in Moment.ts:65

+

Defined in Moment.ts:65

description: Returns the BN representation of the timestamp

Returns: BN


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

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in Moment.ts:72

+

Defined in Moment.ts:72

description: Returns a hex string representation of the value

Returns: string


@@ -2035,14 +2035,14 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Overrides Date.toJSON

-

Defined in Moment.ts:79

+

Defined in Moment.ts:79

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

Returns: any


toNumber

▸ toNumber(): number

-

Defined in Moment.ts:86

+

Defined in Moment.ts:86

description: Returns the number representation for the timestamp

Returns: number


@@ -2051,14 +2051,14 @@

▸ toString(): string

Implementation of Codec.toString

Overrides Date.toString

-

Defined in Moment.ts:93

+

Defined in Moment.ts:93

description: Returns the string representation of the value

Returns: string


toU8a

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

-

Defined in Moment.ts:102

+

Defined in Moment.ts:102

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

Parameters:

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

<Static> decodeMoment

▸ decodeMoment(value: Moment | Date | AnyNumber): Date

-

Defined in Moment.ts:34

+

Defined in Moment.ts:34

Parameters:

@@ -2143,7 +2143,7 @@ diff --git a/docs/types/classes/_moment_.moment.md b/docs/types/classes/_moment_.moment.md index e84387fdb9..567c7311c1 100644 --- a/docs/types/classes/_moment_.moment.md +++ b/docs/types/classes/_moment_.moment.md @@ -22,7 +22,7 @@ ⊕ **new Moment**(value?: * [Moment](_moment_.moment.md) | `Date` | [AnyNumber](../modules/_types_.md#anynumber)*): [Moment](_moment_.moment.md) -*Defined in [Moment.ts:24](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Moment.ts#L24)* +*Defined in [Moment.ts:24](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Moment.ts#L24)* **Parameters:** @@ -54,7 +54,7 @@ ___ getencodedLength(): `number` -*Defined in [Moment.ts:51](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Moment.ts#L51)* +*Defined in [Moment.ts:51](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Moment.ts#L51)* *__description__*: The length of the value when encoded as a Uint8Array @@ -70,7 +70,7 @@ ___ ▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) -*Defined in [Moment.ts:58](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Moment.ts#L58)* +*Defined in [Moment.ts:58](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Moment.ts#L58)* *__description__*: Returns the number of bits in the value @@ -83,7 +83,7 @@ ___ ▸ **toBn**(): `BN` -*Defined in [Moment.ts:65](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Moment.ts#L65)* +*Defined in [Moment.ts:65](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Moment.ts#L65)* *__description__*: Returns the BN representation of the timestamp @@ -98,7 +98,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [Moment.ts:72](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Moment.ts#L72)* +*Defined in [Moment.ts:72](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Moment.ts#L72)* *__description__*: Returns a hex string representation of the value @@ -115,7 +115,7 @@ ___ *Overrides Date.toJSON* -*Defined in [Moment.ts:79](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Moment.ts#L79)* +*Defined in [Moment.ts:79](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Moment.ts#L79)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -128,7 +128,7 @@ ___ ▸ **toNumber**(): `number` -*Defined in [Moment.ts:86](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Moment.ts#L86)* +*Defined in [Moment.ts:86](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Moment.ts#L86)* *__description__*: Returns the number representation for the timestamp @@ -145,7 +145,7 @@ ___ *Overrides Date.toString* -*Defined in [Moment.ts:93](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Moment.ts#L93)* +*Defined in [Moment.ts:93](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Moment.ts#L93)* *__description__*: Returns the string representation of the value @@ -158,7 +158,7 @@ ___ ▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` -*Defined in [Moment.ts:102](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Moment.ts#L102)* +*Defined in [Moment.ts:102](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Moment.ts#L102)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -177,7 +177,7 @@ ___ ▸ **decodeMoment**(value: * [Moment](_moment_.moment.md) | `Date` | [AnyNumber](../modules/_types_.md#anynumber)*): `Date` -*Defined in [Moment.ts:34](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Moment.ts#L34)* +*Defined in [Moment.ts:34](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Moment.ts#L34)* **Parameters:** diff --git a/docs/types/classes/_newaccountoutcome_.newaccountoutcome.html b/docs/types/classes/_newaccountoutcome_.newaccountoutcome.html index 0879e90438..c2272c5273 100644 --- a/docs/types/classes/_newaccountoutcome_.newaccountoutcome.html +++ b/docs/types/classes/_newaccountoutcome_.newaccountoutcome.html @@ -1974,7 +1974,7 @@

constructor

⊕ new NewAccountOutcome(index?: U8a | Uint8Array | number): NewAccountOutcome

Overrides Enum.constructor

-

Defined in NewAccountOutcome.ts:13

+

Defined in NewAccountOutcome.ts:13

Parameters:

@@ -1997,7 +1997,7 @@

encodedLength

getencodedLength(): number

Inherited from Enum.encodedLength

-

Defined in codec/Enum.ts:64

+

Defined in codec/Enum.ts:64

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

Returns: number


@@ -2007,7 +2007,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Enum.toHex

-

Defined in codec/Enum.ts:71

+

Defined in codec/Enum.ts:71

description: Returns a hex string representation of the value

Returns: string


@@ -2016,7 +2016,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Enum.toJSON

-

Defined in codec/Enum.ts:78

+

Defined in codec/Enum.ts:78

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

Returns: any


@@ -2024,7 +2024,7 @@

toNumber

▸ toNumber(): number

Inherited from Enum.toNumber

-

Defined in codec/Enum.ts:85

+

Defined in codec/Enum.ts:85

description: Returns the number representation for the value

Returns: number


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

▸ toString(): string

Implementation of Codec.toString

Inherited from Enum.toString

-

Defined in codec/Enum.ts:92

+

Defined in codec/Enum.ts:92

description: Returns the string representation of the value

Returns: string


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

toU8a

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

Inherited from Enum.toU8a

-

Defined in codec/Enum.ts:100

+

Defined in codec/Enum.ts:100

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

Parameters:

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

<Static> decodeEnum

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

Inherited from Enum.decodeEnum

-

Defined in codec/Enum.ts:47

+

Defined in codec/Enum.ts:47

Parameters:

@@ -2131,7 +2131,7 @@ diff --git a/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md b/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md index 53b46a126c..f58762cda3 100644 --- a/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md +++ b/docs/types/classes/_newaccountoutcome_.newaccountoutcome.md @@ -24,7 +24,7 @@ *Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* -*Defined in [NewAccountOutcome.ts:13](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/NewAccountOutcome.ts#L13)* +*Defined in [NewAccountOutcome.ts:13](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/NewAccountOutcome.ts#L13)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from [Enum](_codec_enum_.enum.md).[encodedLength](_codec_enum_.enum.md#encodedlength)* -*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L64)* +*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toHex](_codec_enum_.enum.md#tohex)* -*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L71)* +*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L71)* *__description__*: Returns a hex string representation of the value @@ -83,7 +83,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toJSON](_codec_enum_.enum.md#tojson)* -*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L78)* +*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L78)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -98,7 +98,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* -*Defined in [codec/Enum.ts:85](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L85)* +*Defined in [codec/Enum.ts:85](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L85)* *__description__*: Returns the number representation for the value @@ -115,7 +115,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toString](_codec_enum_.enum.md#tostring)* -*Defined in [codec/Enum.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L92)* +*Defined in [codec/Enum.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L92)* *__description__*: Returns the string representation of the value @@ -130,7 +130,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toU8a](_codec_enum_.enum.md#tou8a)* -*Defined in [codec/Enum.ts:100](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L100)* +*Defined in [codec/Enum.ts:100](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L100)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -151,7 +151,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[decodeEnum](_codec_enum_.enum.md#decodeenum)* -*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L47)* +*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L47)* **Parameters:** diff --git a/docs/types/classes/_nonce_.nonce.html b/docs/types/classes/_nonce_.nonce.html index 190ecca0c0..709a71e0b2 100644 --- a/docs/types/classes/_nonce_.nonce.html +++ b/docs/types/classes/_nonce_.nonce.html @@ -1975,7 +1975,7 @@

⊕ new Nonce(value?: AnyNumber): Nonce

Inherited from U64.constructor

Overrides UInt.constructor

-

Defined in U64.ts:14

+

Defined in U64.ts:14

Parameters:

@@ -1998,7 +1998,7 @@

encodedLength

getencodedLength(): number

Inherited from AbstractInt.encodedLength

-

Defined in codec/AbstractInt.ts:56

+

Defined in codec/AbstractInt.ts:56

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

Returns: number


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

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

-

Defined in codec/AbstractInt.ts:63

+

Defined in codec/AbstractInt.ts:63

description: Returns the number of bits in the value

Returns: UIntBitLength


@@ -3509,7 +3509,7 @@

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

-

Defined in codec/AbstractInt.ts:70

+

Defined in codec/AbstractInt.ts:70

description: Returns the BN representation of the number. (Compatibility)

Returns: BN


@@ -3546,7 +3546,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -3556,7 +3556,7 @@

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

-

Defined in codec/AbstractInt.ts:82

+

Defined in codec/AbstractInt.ts:82

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

Returns: any


@@ -3596,7 +3596,7 @@

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

-

Defined in codec/AbstractInt.ts:92

+

Defined in codec/AbstractInt.ts:92

description: Returns the string representation of the value

Parameters:

@@ -3645,7 +3645,7 @@

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

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -3862,7 +3862,7 @@

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

-

Defined in codec/AbstractInt.ts:37

+

Defined in codec/AbstractInt.ts:37

Parameters:

@@ -4054,7 +4054,7 @@ diff --git a/docs/types/classes/_nonce_.nonce.md b/docs/types/classes/_nonce_.nonce.md index 9ebce7d27c..3fe2acd2a8 100644 --- a/docs/types/classes/_nonce_.nonce.md +++ b/docs/types/classes/_nonce_.nonce.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/U64.ts#L14)* +*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/U64.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -188,7 +188,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1523,7 +1523,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1564,7 +1564,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1583,7 +1583,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1636,7 +1636,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1680,7 +1680,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1884,7 +1884,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_null_.null.html b/docs/types/classes/_null_.null.html index 46d33cecb2..77752dd683 100644 --- a/docs/types/classes/_null_.null.html +++ b/docs/types/classes/_null_.null.html @@ -1978,7 +1978,7 @@

encodedLength

getencodedLength(): number

-

Defined in Null.ts:16

+

Defined in Null.ts:16

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

Returns: number


@@ -1987,7 +1987,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in Null.ts:23

+

Defined in Null.ts:23

description: Returns a hex string representation of the value

Returns: string


@@ -1995,7 +1995,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in Null.ts:30

+

Defined in Null.ts:30

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

Returns: any


@@ -2003,14 +2003,14 @@

toString

▸ toString(): string

Implementation of Codec.toString

-

Defined in Null.ts:37

+

Defined in Null.ts:37

description: Returns the string representation of the value

Returns: string


toU8a

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

-

Defined in Null.ts:45

+

Defined in Null.ts:45

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

Parameters:

@@ -2074,7 +2074,7 @@ diff --git a/docs/types/classes/_null_.null.md b/docs/types/classes/_null_.null.md index 3901b55509..6728239aa6 100644 --- a/docs/types/classes/_null_.null.md +++ b/docs/types/classes/_null_.null.md @@ -32,7 +32,7 @@ getencodedLength(): `number` -*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L16)* +*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L16)* *__description__*: The length of the value when encoded as a Uint8Array @@ -50,7 +50,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L23)* +*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L23)* *__description__*: Returns a hex string representation of the value @@ -65,7 +65,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L30)* +*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L30)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -80,7 +80,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* -*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L37)* +*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L37)* *__description__*: Returns the string representation of the value @@ -93,7 +93,7 @@ ___ ▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` -*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L45)* +*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L45)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_origin_.origin.html b/docs/types/classes/_origin_.origin.html index bff321c03c..de0f096259 100644 --- a/docs/types/classes/_origin_.origin.html +++ b/docs/types/classes/_origin_.origin.html @@ -1973,7 +1973,7 @@

constructor

⊕ new Origin(): Origin

-

Defined in Origin.ts:13

+

Defined in Origin.ts:13

Returns: Origin


Accessors

@@ -1981,7 +1981,7 @@

encodedLength

getencodedLength(): number

Inherited from Null.encodedLength

-

Defined in Null.ts:16

+

Defined in Null.ts:16

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

Returns: number


@@ -1991,7 +1991,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Null.toHex

-

Defined in Null.ts:23

+

Defined in Null.ts:23

description: Returns a hex string representation of the value

Returns: string


@@ -2000,7 +2000,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Null.toJSON

-

Defined in Null.ts:30

+

Defined in Null.ts:30

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

Returns: any


@@ -2009,7 +2009,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Null.toString

-

Defined in Null.ts:37

+

Defined in Null.ts:37

description: Returns the string representation of the value

Returns: string


@@ -2017,7 +2017,7 @@

toU8a

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

Inherited from Null.toU8a

-

Defined in Null.ts:45

+

Defined in Null.ts:45

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

Parameters:

@@ -2081,7 +2081,7 @@ diff --git a/docs/types/classes/_origin_.origin.md b/docs/types/classes/_origin_.origin.md index e5780c7baf..caee09a28d 100644 --- a/docs/types/classes/_origin_.origin.md +++ b/docs/types/classes/_origin_.origin.md @@ -22,7 +22,7 @@ ⊕ **new Origin**(): [Origin](_origin_.origin.md) -*Defined in [Origin.ts:13](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Origin.ts#L13)* +*Defined in [Origin.ts:13](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Origin.ts#L13)* **Returns:** [Origin](_origin_.origin.md) @@ -38,7 +38,7 @@ getencodedLength(): `number` *Inherited from [Null](_null_.null.md).[encodedLength](_null_.null.md#encodedlength)* -*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L16)* +*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L16)* *__description__*: The length of the value when encoded as a Uint8Array @@ -58,7 +58,7 @@ ___ *Inherited from [Null](_null_.null.md).[toHex](_null_.null.md#tohex)* -*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L23)* +*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L23)* *__description__*: Returns a hex string representation of the value @@ -75,7 +75,7 @@ ___ *Inherited from [Null](_null_.null.md).[toJSON](_null_.null.md#tojson)* -*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L30)* +*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L30)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -92,7 +92,7 @@ ___ *Inherited from [Null](_null_.null.md).[toString](_null_.null.md#tostring)* -*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L37)* +*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L37)* *__description__*: Returns the string representation of the value @@ -107,7 +107,7 @@ ___ *Inherited from [Null](_null_.null.md).[toU8a](_null_.null.md#tou8a)* -*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Null.ts#L45)* +*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Null.ts#L45)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_paraid_.paraid.md b/docs/types/classes/_paraid_.paraid.md index 4e0634105c..d4d2f47633 100644 --- a/docs/types/classes/_paraid_.paraid.md +++ b/docs/types/classes/_paraid_.paraid.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/U32.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -188,7 +188,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1523,7 +1523,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1564,7 +1564,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1583,7 +1583,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1636,7 +1636,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1680,7 +1680,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1884,7 +1884,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_pendingextrinsics_.pendingextrinsics.html b/docs/types/classes/_pendingextrinsics_.pendingextrinsics.html index 69da6f632e..0c5e5d1a38 100644 --- a/docs/types/classes/_pendingextrinsics_.pendingextrinsics.html +++ b/docs/types/classes/_pendingextrinsics_.pendingextrinsics.html @@ -1978,7 +1978,7 @@

constructor

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

Inherited from Vector.constructor

-

Defined in codec/Vector.ts:22

+

Defined in codec/Vector.ts:22

Parameters:

@@ -2008,14 +2008,14 @@

Type

getType(): string

Inherited from Vector.Type

-

Defined in codec/Vector.ts:57

+

Defined in codec/Vector.ts:57

Returns: string


encodedLength

getencodedLength(): number

Inherited from Vector.encodedLength

-

Defined in codec/Vector.ts:64

+

Defined in codec/Vector.ts:64

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

Returns: number


@@ -2024,7 +2024,7 @@

getlength(): number

Inherited from Vector.length

Overrides Array.length

-

Defined in codec/Vector.ts:73

+

Defined in codec/Vector.ts:73

description: The length of the value

Returns: number


@@ -2205,7 +2205,7 @@

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

Inherited from Vector.filter

Overrides Array.filter

-

Defined in codec/Vector.ts:139

+

Defined in codec/Vector.ts:139

description: Filters the array with the callback

Parameters:

@@ -2758,7 +2758,7 @@

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

Inherited from Vector.map

Overrides Array.map

-

Defined in codec/Vector.ts:148

+

Defined in codec/Vector.ts:148

description: Maps the array with the callback

Type parameters:

U

@@ -3140,7 +3140,7 @@

toArray

▸ toArray(): Array<T>

Inherited from Vector.toArray

-

Defined in codec/Vector.ts:81

+

Defined in codec/Vector.ts:81

description: Converts the Object to an standard JavaScript Array

Returns: Array<T>


@@ -3149,7 +3149,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Vector.toHex

-

Defined in codec/Vector.ts:88

+

Defined in codec/Vector.ts:88

description: Returns a hex string representation of the value

Returns: string


@@ -3158,7 +3158,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Vector.toJSON

-

Defined in codec/Vector.ts:95

+

Defined in codec/Vector.ts:95

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

Returns: any


@@ -3176,7 +3176,7 @@

Implementation of Codec.toString

Inherited from Vector.toString

Overrides Array.toString

-

Defined in codec/Vector.ts:104

+

Defined in codec/Vector.ts:104

description: Returns the string representation of the value

Returns: string


@@ -3184,7 +3184,7 @@

toU8a

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

Inherited from Vector.toU8a

-

Defined in codec/Vector.ts:117

+

Defined in codec/Vector.ts:117

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

Parameters:

@@ -3242,7 +3242,7 @@

<Static> decodeVector

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

Inherited from Vector.decodeVector

-

Defined in codec/Vector.ts:32

+

Defined in codec/Vector.ts:32

Type parameters:

T : Codec

Parameters:

@@ -3270,7 +3270,7 @@

<Static> with

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

Inherited from Vector.with

-

Defined in codec/Vector.ts:49

+

Defined in codec/Vector.ts:49

Type parameters:

O : Codec

Parameters:

@@ -3333,7 +3333,7 @@ diff --git a/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md b/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md index b969f9679f..216e37be54 100644 --- a/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md +++ b/docs/types/classes/_pendingextrinsics_.pendingextrinsics.md @@ -29,7 +29,7 @@ *Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)* -*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L22)* +*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L22)* **Parameters:** @@ -52,7 +52,7 @@ getType(): `string` *Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* -*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L57)* +*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L57)* **Returns:** `string` @@ -65,7 +65,7 @@ getencodedLength(): `number` *Inherited from [Vector](_codec_vector_.vector.md).[encodedLength](_codec_vector_.vector.md#encodedlength)* -*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L64)* +*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -82,7 +82,7 @@ getlength(): `number` *Overrides Array.length* -*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L73)* +*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L73)* *__description__*: The length of the value @@ -252,7 +252,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L139)* +*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L139)* *__description__*: Filters the array with the callback @@ -672,7 +672,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L148)* +*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L148)* *__description__*: Maps the array with the callback @@ -980,7 +980,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)* -*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L81)* +*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L81)* *__description__*: Converts the Object to an standard JavaScript Array @@ -997,7 +997,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)* -*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L88)* +*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L88)* *__description__*: Returns a hex string representation of the value @@ -1014,7 +1014,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* -*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L95)* +*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L95)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1048,7 +1048,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L104)* +*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L104)* *__description__*: Returns the string representation of the value @@ -1063,7 +1063,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* -*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L117)* +*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L117)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1120,7 +1120,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/e79c6d8/packages/types/src/codec/Vector.ts#L32)* +*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L32)* **Type parameters:** @@ -1143,7 +1143,7 @@ ___ *Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* -*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Vector.ts#L49)* +*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Vector.ts#L49)* **Type parameters:** diff --git a/docs/types/classes/_perbill_.perbill.html b/docs/types/classes/_perbill_.perbill.html index 851c762cea..c18457064e 100644 --- a/docs/types/classes/_perbill_.perbill.html +++ b/docs/types/classes/_perbill_.perbill.html @@ -1975,7 +1975,7 @@

⊕ new Perbill(value?: AnyNumber): Perbill

Inherited from U32.constructor

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -1998,7 +1998,7 @@

encodedLength

getencodedLength(): number

Inherited from AbstractInt.encodedLength

-

Defined in codec/AbstractInt.ts:56

+

Defined in codec/AbstractInt.ts:56

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

Returns: number


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

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

-

Defined in codec/AbstractInt.ts:63

+

Defined in codec/AbstractInt.ts:63

description: Returns the number of bits in the value

Returns: UIntBitLength


@@ -3509,7 +3509,7 @@

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

-

Defined in codec/AbstractInt.ts:70

+

Defined in codec/AbstractInt.ts:70

description: Returns the BN representation of the number. (Compatibility)

Returns: BN


@@ -3546,7 +3546,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -3556,7 +3556,7 @@

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

-

Defined in codec/AbstractInt.ts:82

+

Defined in codec/AbstractInt.ts:82

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

Returns: any


@@ -3596,7 +3596,7 @@

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

-

Defined in codec/AbstractInt.ts:92

+

Defined in codec/AbstractInt.ts:92

description: Returns the string representation of the value

Parameters:

@@ -3645,7 +3645,7 @@

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

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -3862,7 +3862,7 @@

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

-

Defined in codec/AbstractInt.ts:37

+

Defined in codec/AbstractInt.ts:37

Parameters:

@@ -4054,7 +4054,7 @@ diff --git a/docs/types/classes/_perbill_.perbill.md b/docs/types/classes/_perbill_.perbill.md index c869193e54..f071ad22a5 100644 --- a/docs/types/classes/_perbill_.perbill.md +++ b/docs/types/classes/_perbill_.perbill.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/U32.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -188,7 +188,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1523,7 +1523,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1564,7 +1564,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1583,7 +1583,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1636,7 +1636,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1680,7 +1680,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1884,7 +1884,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_permill_.permill.html b/docs/types/classes/_permill_.permill.html index 2f096c5d60..eab57ac608 100644 --- a/docs/types/classes/_permill_.permill.html +++ b/docs/types/classes/_permill_.permill.html @@ -1975,7 +1975,7 @@

⊕ new Permill(value?: AnyNumber): Permill

Inherited from U32.constructor

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -1998,7 +1998,7 @@

encodedLength

getencodedLength(): number

Inherited from AbstractInt.encodedLength

-

Defined in codec/AbstractInt.ts:56

+

Defined in codec/AbstractInt.ts:56

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

Returns: number


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

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

-

Defined in codec/AbstractInt.ts:63

+

Defined in codec/AbstractInt.ts:63

description: Returns the number of bits in the value

Returns: UIntBitLength


@@ -3509,7 +3509,7 @@

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

-

Defined in codec/AbstractInt.ts:70

+

Defined in codec/AbstractInt.ts:70

description: Returns the BN representation of the number. (Compatibility)

Returns: BN


@@ -3546,7 +3546,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -3556,7 +3556,7 @@

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

-

Defined in codec/AbstractInt.ts:82

+

Defined in codec/AbstractInt.ts:82

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

Returns: any


@@ -3596,7 +3596,7 @@

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

-

Defined in codec/AbstractInt.ts:92

+

Defined in codec/AbstractInt.ts:92

description: Returns the string representation of the value

Parameters:

@@ -3645,7 +3645,7 @@

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

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -3862,7 +3862,7 @@

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

-

Defined in codec/AbstractInt.ts:37

+

Defined in codec/AbstractInt.ts:37

Parameters:

@@ -4054,7 +4054,7 @@ diff --git a/docs/types/classes/_permill_.permill.md b/docs/types/classes/_permill_.permill.md index 458060e368..c64bf6d795 100644 --- a/docs/types/classes/_permill_.permill.md +++ b/docs/types/classes/_permill_.permill.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/U32.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -188,7 +188,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1523,7 +1523,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1564,7 +1564,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1583,7 +1583,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1636,7 +1636,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1680,7 +1680,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1884,7 +1884,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_propindex_.propindex.html b/docs/types/classes/_propindex_.propindex.html index 7146816cd6..690f390366 100644 --- a/docs/types/classes/_propindex_.propindex.html +++ b/docs/types/classes/_propindex_.propindex.html @@ -1975,7 +1975,7 @@

⊕ new PropIndex(value?: AnyNumber): PropIndex

Inherited from U32.constructor

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -1998,7 +1998,7 @@

encodedLength

getencodedLength(): number

Inherited from AbstractInt.encodedLength

-

Defined in codec/AbstractInt.ts:56

+

Defined in codec/AbstractInt.ts:56

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

Returns: number


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

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

-

Defined in codec/AbstractInt.ts:63

+

Defined in codec/AbstractInt.ts:63

description: Returns the number of bits in the value

Returns: UIntBitLength


@@ -3509,7 +3509,7 @@

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

-

Defined in codec/AbstractInt.ts:70

+

Defined in codec/AbstractInt.ts:70

description: Returns the BN representation of the number. (Compatibility)

Returns: BN


@@ -3546,7 +3546,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -3556,7 +3556,7 @@

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

-

Defined in codec/AbstractInt.ts:82

+

Defined in codec/AbstractInt.ts:82

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

Returns: any


@@ -3596,7 +3596,7 @@

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

-

Defined in codec/AbstractInt.ts:92

+

Defined in codec/AbstractInt.ts:92

description: Returns the string representation of the value

Parameters:

@@ -3645,7 +3645,7 @@

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

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -3862,7 +3862,7 @@

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

-

Defined in codec/AbstractInt.ts:37

+

Defined in codec/AbstractInt.ts:37

Parameters:

@@ -4054,7 +4054,7 @@ diff --git a/docs/types/classes/_propindex_.propindex.md b/docs/types/classes/_propindex_.propindex.md index 130743bb6d..9da648992f 100644 --- a/docs/types/classes/_propindex_.propindex.md +++ b/docs/types/classes/_propindex_.propindex.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/U32.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -188,7 +188,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1523,7 +1523,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1564,7 +1564,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1583,7 +1583,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1636,7 +1636,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1680,7 +1680,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1884,7 +1884,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_proposal_.proposal.html b/docs/types/classes/_proposal_.proposal.html index 9f9026bdd8..d07752c550 100644 --- a/docs/types/classes/_proposal_.proposal.html +++ b/docs/types/classes/_proposal_.proposal.html @@ -1980,7 +1980,7 @@

⊕ new Proposal(value: any, meta?: FunctionMetadata): Proposal

Inherited from Method.constructor

Overrides Struct.constructor

-

Defined in Method.ts:70

+

Defined in Method.ts:70

Parameters:

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

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


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

args

getargs(): Array<Codec>

Inherited from Method.args

-

Defined in Method.ts:185

+

Defined in Method.ts:185

description: The arguments for the function call

Returns: Array<Codec>


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

argsDef

getargsDef(): ArgsDef

Inherited from Method.argsDef

-

Defined in Method.ts:193

+

Defined in Method.ts:193

description: Thge argument defintions

Returns: ArgsDef


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

callIndex

getcallIndex(): Uint8Array

Inherited from Method.callIndex

-

Defined in Method.ts:200

+

Defined in Method.ts:200

description: The encoded [sectionIndex, methodIndex] identifier

Returns: Uint8Array


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

data

getdata(): Uint8Array

Inherited from Method.data

-

Defined in Method.ts:207

+

Defined in Method.ts:207

description: The encoded data

Returns: Uint8Array


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

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


@@ -2068,7 +2068,7 @@

hasOrigin

gethasOrigin(): boolean

Inherited from Method.hasOrigin

-

Defined in Method.ts:214

+

Defined in Method.ts:214

description: true if the Origin type is on the method (extrinsic method)

Returns: boolean


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

meta

getmeta(): FunctionMetadata

Inherited from Method.meta

-

Defined in Method.ts:223

+

Defined in Method.ts:223

description: The FunctionMetadata

Returns: FunctionMetadata


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

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

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

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

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

Parameters:

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

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2270,7 +2270,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2279,7 +2279,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

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

Returns: any


@@ -2288,7 +2288,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2296,7 +2296,7 @@

toU8a

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

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

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

Parameters:

@@ -2329,7 +2329,7 @@

<Static> filterOrigin

▸ filterOrigin(meta?: FunctionMetadata): Array<FunctionArgumentMetadata>

Inherited from Method.filterOrigin

-

Defined in Method.ts:133

+

Defined in Method.ts:133

Parameters:

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

<Static> findFunction

▸ findFunction(callIndex: Uint8Array): MethodFunction

Inherited from Method.findFunction

-

Defined in Method.ts:149

+

Defined in Method.ts:149

Parameters:

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

<Static> injectMethods

▸ injectMethods(moduleMethods: ModulesWithMethods): void

Inherited from Method.injectMethods

-

Defined in Method.ts:174

+

Defined in Method.ts:174

Parameters:

@@ -2395,7 +2395,7 @@

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2458,7 +2458,7 @@ diff --git a/docs/types/classes/_proposal_.proposal.md b/docs/types/classes/_proposal_.proposal.md index 1221587c56..fb89c52581 100644 --- a/docs/types/classes/_proposal_.proposal.md +++ b/docs/types/classes/_proposal_.proposal.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [Method.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L70)* +*Defined in [Method.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -94,7 +94,7 @@ getargs(): `Array`<[Codec](../interfaces/_types_.codec.md)> *Inherited from [Method](_method_.method.md).[args](_method_.method.md#args)* -*Defined in [Method.ts:185](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L185)* +*Defined in [Method.ts:185](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L185)* *__description__*: The arguments for the function call @@ -109,7 +109,7 @@ getargsDef(): `ArgsDef` *Inherited from [Method](_method_.method.md).[argsDef](_method_.method.md#argsdef)* -*Defined in [Method.ts:193](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L193)* +*Defined in [Method.ts:193](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L193)* *__description__*: Thge argument defintions @@ -124,7 +124,7 @@ getcallIndex(): `Uint8Array` *Inherited from [Method](_method_.method.md).[callIndex](_method_.method.md#callindex)* -*Defined in [Method.ts:200](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L200)* +*Defined in [Method.ts:200](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L200)* *__description__*: The encoded `[sectionIndex, methodIndex]` identifier @@ -139,7 +139,7 @@ getdata(): `Uint8Array` *Inherited from [Method](_method_.method.md).[data](_method_.method.md#data)* -*Defined in [Method.ts:207](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L207)* +*Defined in [Method.ts:207](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L207)* *__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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -169,7 +169,7 @@ gethasOrigin(): `boolean` *Inherited from [Method](_method_.method.md).[hasOrigin](_method_.method.md#hasorigin)* -*Defined in [Method.ts:214](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L214)* +*Defined in [Method.ts:214](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L214)* *__description__*: `true` if the `Origin` type is on the method (extrinsic method) @@ -184,7 +184,7 @@ getmeta(): [FunctionMetadata](_metadata_modules_.functionmetadata.md) *Inherited from [Method](_method_.method.md).[meta](_method_.method.md#meta)* -*Defined in [Method.ts:223](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L223)* +*Defined in [Method.ts:223](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L223)* *__description__*: The [FunctionMetadata](_metadata_modules_.functionmetadata.md) @@ -286,7 +286,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__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:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -382,7 +382,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__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:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__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:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__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:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -448,7 +448,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -484,7 +484,7 @@ ___ *Inherited from [Method](_method_.method.md).[filterOrigin](_method_.method.md#filterorigin)* -*Defined in [Method.ts:133](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L133)* +*Defined in [Method.ts:133](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L133)* **Parameters:** @@ -503,7 +503,7 @@ ___ *Inherited from [Method](_method_.method.md).[findFunction](_method_.method.md#findfunction)* -*Defined in [Method.ts:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L149)* +*Defined in [Method.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L149)* **Parameters:** @@ -522,7 +522,7 @@ ___ *Inherited from [Method](_method_.method.md).[injectMethods](_method_.method.md#injectmethods)* -*Defined in [Method.ts:174](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L174)* +*Defined in [Method.ts:174](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L174)* **Parameters:** @@ -541,7 +541,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_proposalindex_.proposalindex.html b/docs/types/classes/_proposalindex_.proposalindex.html index dbd45bb295..9f92311604 100644 --- a/docs/types/classes/_proposalindex_.proposalindex.html +++ b/docs/types/classes/_proposalindex_.proposalindex.html @@ -1975,7 +1975,7 @@

⊕ new ProposalIndex(value?: AnyNumber): ProposalIndex

Inherited from U32.constructor

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -1998,7 +1998,7 @@

encodedLength

getencodedLength(): number

Inherited from AbstractInt.encodedLength

-

Defined in codec/AbstractInt.ts:56

+

Defined in codec/AbstractInt.ts:56

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

Returns: number


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

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

-

Defined in codec/AbstractInt.ts:63

+

Defined in codec/AbstractInt.ts:63

description: Returns the number of bits in the value

Returns: UIntBitLength


@@ -3509,7 +3509,7 @@

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

-

Defined in codec/AbstractInt.ts:70

+

Defined in codec/AbstractInt.ts:70

description: Returns the BN representation of the number. (Compatibility)

Returns: BN


@@ -3546,7 +3546,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -3556,7 +3556,7 @@

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

-

Defined in codec/AbstractInt.ts:82

+

Defined in codec/AbstractInt.ts:82

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

Returns: any


@@ -3596,7 +3596,7 @@

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

-

Defined in codec/AbstractInt.ts:92

+

Defined in codec/AbstractInt.ts:92

description: Returns the string representation of the value

Parameters:

@@ -3645,7 +3645,7 @@

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

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -3862,7 +3862,7 @@

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

-

Defined in codec/AbstractInt.ts:37

+

Defined in codec/AbstractInt.ts:37

Parameters:

@@ -4054,7 +4054,7 @@ diff --git a/docs/types/classes/_proposalindex_.proposalindex.md b/docs/types/classes/_proposalindex_.proposalindex.md index 309e9c93b8..655b740ffe 100644 --- a/docs/types/classes/_proposalindex_.proposalindex.md +++ b/docs/types/classes/_proposalindex_.proposalindex.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/U32.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -188,7 +188,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1523,7 +1523,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1564,7 +1564,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1583,7 +1583,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1636,7 +1636,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1680,7 +1680,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1884,7 +1884,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_referendumindex_.referendumindex.html b/docs/types/classes/_referendumindex_.referendumindex.html index 51ebc95ade..16499572f0 100644 --- a/docs/types/classes/_referendumindex_.referendumindex.html +++ b/docs/types/classes/_referendumindex_.referendumindex.html @@ -1975,7 +1975,7 @@

⊕ new ReferendumIndex(value?: AnyNumber): ReferendumIndex

Inherited from U32.constructor

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -1998,7 +1998,7 @@

encodedLength

getencodedLength(): number

Inherited from AbstractInt.encodedLength

-

Defined in codec/AbstractInt.ts:56

+

Defined in codec/AbstractInt.ts:56

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

Returns: number


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

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

-

Defined in codec/AbstractInt.ts:63

+

Defined in codec/AbstractInt.ts:63

description: Returns the number of bits in the value

Returns: UIntBitLength


@@ -3509,7 +3509,7 @@

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

-

Defined in codec/AbstractInt.ts:70

+

Defined in codec/AbstractInt.ts:70

description: Returns the BN representation of the number. (Compatibility)

Returns: BN


@@ -3546,7 +3546,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -3556,7 +3556,7 @@

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

-

Defined in codec/AbstractInt.ts:82

+

Defined in codec/AbstractInt.ts:82

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

Returns: any


@@ -3596,7 +3596,7 @@

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

-

Defined in codec/AbstractInt.ts:92

+

Defined in codec/AbstractInt.ts:92

description: Returns the string representation of the value

Parameters:

@@ -3645,7 +3645,7 @@

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

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

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

Parameters:

@@ -3862,7 +3862,7 @@

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

-

Defined in codec/AbstractInt.ts:37

+

Defined in codec/AbstractInt.ts:37

Parameters:

@@ -4054,7 +4054,7 @@ diff --git a/docs/types/classes/_referendumindex_.referendumindex.md b/docs/types/classes/_referendumindex_.referendumindex.md index 0ae2b3a874..adb1e620e0 100644 --- a/docs/types/classes/_referendumindex_.referendumindex.md +++ b/docs/types/classes/_referendumindex_.referendumindex.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/U32.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -188,7 +188,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1523,7 +1523,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1564,7 +1564,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1583,7 +1583,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1636,7 +1636,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1680,7 +1680,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1884,7 +1884,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_referenduminfo_.referenduminfo.md b/docs/types/classes/_referenduminfo_.referenduminfo.md index 4c94d2ec45..1f1777bff4 100644 --- a/docs/types/classes/_referenduminfo_.referenduminfo.md +++ b/docs/types/classes/_referenduminfo_.referenduminfo.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [ReferendumInfo.ts:22](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/ReferendumInfo.ts#L22)* +*Defined in [ReferendumInfo.ts:22](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/ReferendumInfo.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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -89,7 +89,7 @@ ___ getdelay(): [BlockNumber](_blocknumber_.blocknumber.md) -*Defined in [ReferendumInfo.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/ReferendumInfo.ts#L56)* +*Defined in [ReferendumInfo.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/ReferendumInfo.ts#L56)* *__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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -117,7 +117,7 @@ ___ getend(): [BlockNumber](_blocknumber_.blocknumber.md) -*Defined in [ReferendumInfo.ts:35](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/ReferendumInfo.ts#L35)* +*Defined in [ReferendumInfo.ts:35](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/ReferendumInfo.ts#L35)* *__description__*: When voting on this referendum will end @@ -130,7 +130,7 @@ ___ getproposal(): [Proposal](_proposal_.proposal.md) -*Defined in [ReferendumInfo.ts:42](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/ReferendumInfo.ts#L42)* +*Defined in [ReferendumInfo.ts:42](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/ReferendumInfo.ts#L42)* *__description__*: The proposal being voted on @@ -143,7 +143,7 @@ ___ getthreshold(): [VoteThreshold](_votethreshold_.votethreshold.md) -*Defined in [ReferendumInfo.ts:49](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/ReferendumInfo.ts#L49)* +*Defined in [ReferendumInfo.ts:49](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/ReferendumInfo.ts#L49)* *__description__*: The thresholding mechanism to determine whether it passed @@ -245,7 +245,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__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:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -341,7 +341,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -358,7 +358,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -375,7 +375,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -392,7 +392,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -407,7 +407,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -443,7 +443,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_runtimeversion_.apiid.html b/docs/types/classes/_runtimeversion_.apiid.html index 850fe43c3d..01beb40d39 100644 --- a/docs/types/classes/_runtimeversion_.apiid.html +++ b/docs/types/classes/_runtimeversion_.apiid.html @@ -1976,7 +1976,7 @@

constructor

⊕ new ApiId(value?: AnyU8a): ApiId

Overrides U8aFixed.constructor

-

Defined in RuntimeVersion.ts:19

+

Defined in RuntimeVersion.ts:19

Parameters:

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


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

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2059,7 +2059,7 @@

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2726,7 +2726,7 @@

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

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

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

Parameters:

@@ -2757,7 +2757,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2766,7 +2766,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

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

Returns: any


@@ -2784,7 +2784,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2792,7 +2792,7 @@

toU8a

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

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

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

Parameters:

@@ -2864,7 +2864,7 @@ diff --git a/docs/types/classes/_runtimeversion_.apiid.md b/docs/types/classes/_runtimeversion_.apiid.md index 53e328e4aa..ebf9e93c39 100644 --- a/docs/types/classes/_runtimeversion_.apiid.md +++ b/docs/types/classes/_runtimeversion_.apiid.md @@ -27,7 +27,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [RuntimeVersion.ts:19](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/RuntimeVersion.ts#L19)* +*Defined in [RuntimeVersion.ts:19](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/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/e79c6d8/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -132,7 +132,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -163,7 +163,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -689,7 +689,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -713,7 +713,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -730,7 +730,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -764,7 +764,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -779,7 +779,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_runtimeversion_.runtimeversion.html b/docs/types/classes/_runtimeversion_.runtimeversion.html index 6c43094b32..562c8ed259 100644 --- a/docs/types/classes/_runtimeversion_.runtimeversion.html +++ b/docs/types/classes/_runtimeversion_.runtimeversion.html @@ -1979,7 +1979,7 @@

constructor

⊕ new RuntimeVersion(value?: RuntimeVersionValue | Uint8Array): RuntimeVersion

Overrides Struct.constructor

-

Defined in RuntimeVersion.ts:72

+

Defined in RuntimeVersion.ts:72

Parameters:

@@ -2015,21 +2015,21 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


apis

getapis(): Vector<RuntimeVersionApi>

-

Defined in RuntimeVersion.ts:93

+

Defined in RuntimeVersion.ts:93

description: The available APIs as RuntimeVersionApi

Returns: Vector<RuntimeVersionApi>


authoringVersion

getauthoringVersion(): U32

-

Defined in RuntimeVersion.ts:100

+

Defined in RuntimeVersion.ts:100

description: The authoring version as U32

Returns: U32


@@ -2037,35 +2037,35 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

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

Returns: number


implName

getimplName(): Text

-

Defined in RuntimeVersion.ts:107

+

Defined in RuntimeVersion.ts:107

description: The implementation name

Returns: Text


implVersion

getimplVersion(): U32

-

Defined in RuntimeVersion.ts:114

+

Defined in RuntimeVersion.ts:114

description: The implementation version

Returns: U32


specName

getspecName(): Text

-

Defined in RuntimeVersion.ts:121

+

Defined in RuntimeVersion.ts:121

description: The specification name

Returns: Text


specVersion

getspecVersion(): U32

-

Defined in RuntimeVersion.ts:128

+

Defined in RuntimeVersion.ts:128

description: The specification version

Returns: U32


@@ -2146,7 +2146,7 @@

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

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

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

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

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

Parameters:

@@ -2250,7 +2250,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2259,7 +2259,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


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

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

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

Returns: any


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

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


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

toU8a

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

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

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

Parameters:

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

<Static> with

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

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2381,7 +2381,7 @@ diff --git a/docs/types/classes/_runtimeversion_.runtimeversion.md b/docs/types/classes/_runtimeversion_.runtimeversion.md index b8d34afadf..02e034be0f 100644 --- a/docs/types/classes/_runtimeversion_.runtimeversion.md +++ b/docs/types/classes/_runtimeversion_.runtimeversion.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [RuntimeVersion.ts:72](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/RuntimeVersion.ts#L72)* +*Defined in [RuntimeVersion.ts:72](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/RuntimeVersion.ts#L72)* **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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -89,7 +89,7 @@ ___ getapis(): [Vector](_codec_vector_.vector.md)<[RuntimeVersionApi](_runtimeversion_.runtimeversionapi.md)> -*Defined in [RuntimeVersion.ts:93](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/RuntimeVersion.ts#L93)* +*Defined in [RuntimeVersion.ts:93](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/RuntimeVersion.ts#L93)* *__description__*: The available APIs as [RuntimeVersionApi](_runtimeversion_.runtimeversionapi.md) @@ -102,7 +102,7 @@ ___ getauthoringVersion(): [U32](_u32_.u32.md) -*Defined in [RuntimeVersion.ts:100](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/RuntimeVersion.ts#L100)* +*Defined in [RuntimeVersion.ts:100](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/RuntimeVersion.ts#L100)* *__description__*: The authoring version as [U32](_u32_.u32.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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -130,7 +130,7 @@ ___ getimplName(): [Text](_text_.text.md) -*Defined in [RuntimeVersion.ts:107](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/RuntimeVersion.ts#L107)* +*Defined in [RuntimeVersion.ts:107](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/RuntimeVersion.ts#L107)* *__description__*: The implementation name @@ -143,7 +143,7 @@ ___ getimplVersion(): [U32](_u32_.u32.md) -*Defined in [RuntimeVersion.ts:114](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/RuntimeVersion.ts#L114)* +*Defined in [RuntimeVersion.ts:114](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/RuntimeVersion.ts#L114)* *__description__*: The implementation version @@ -156,7 +156,7 @@ ___ getspecName(): [Text](_text_.text.md) -*Defined in [RuntimeVersion.ts:121](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/RuntimeVersion.ts#L121)* +*Defined in [RuntimeVersion.ts:121](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/RuntimeVersion.ts#L121)* *__description__*: The specification name @@ -169,7 +169,7 @@ ___ getspecVersion(): [U32](_u32_.u32.md) -*Defined in [RuntimeVersion.ts:128](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/RuntimeVersion.ts#L128)* +*Defined in [RuntimeVersion.ts:128](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/RuntimeVersion.ts#L128)* *__description__*: The specification version @@ -271,7 +271,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__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:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -367,7 +367,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -384,7 +384,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -401,7 +401,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -418,7 +418,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -433,7 +433,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -469,7 +469,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_runtimeversion_.runtimeversionapi.html b/docs/types/classes/_runtimeversion_.runtimeversionapi.html index fbdb078ab0..c3b554ae3d 100644 --- a/docs/types/classes/_runtimeversion_.runtimeversionapi.html +++ b/docs/types/classes/_runtimeversion_.runtimeversionapi.html @@ -1978,7 +1978,7 @@

constructor

⊕ new RuntimeVersionApi(value?: RuntimeVersionApiValue | Uint8Array): RuntimeVersionApi

Overrides Tuple.constructor

-

Defined in RuntimeVersion.ts:35

+

Defined in RuntimeVersion.ts:35

Parameters:

@@ -2009,7 +2009,7 @@

Types

getTypes(): Array<string>

Inherited from Tuple.Types

-

Defined in codec/Tuple.ts:65

+

Defined in codec/Tuple.ts:65

description: The types definition of the tuple

Returns: Array<string>


@@ -2017,21 +2017,21 @@

encodedLength

getencodedLength(): number

Inherited from Tuple.encodedLength

-

Defined in codec/Tuple.ts:56

+

Defined in codec/Tuple.ts:56

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

Returns: number


id

getid(): ApiId

-

Defined in RuntimeVersion.ts:46

+

Defined in RuntimeVersion.ts:46

description: The ApiId

Returns: ApiId


version

getversion(): U32

-

Defined in RuntimeVersion.ts:53

+

Defined in RuntimeVersion.ts:53

description: The specific version as U32

Returns: U32


@@ -2212,7 +2212,7 @@

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

Inherited from Tuple.filter

Overrides Array.filter

-

Defined in codec/Tuple.ts:121

+

Defined in codec/Tuple.ts:121

description: Filters the array with the callback

Parameters:

@@ -2765,7 +2765,7 @@

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

Inherited from Tuple.map

Overrides Array.map

-

Defined in codec/Tuple.ts:130

+

Defined in codec/Tuple.ts:130

description: Maps the array with the callback

Type parameters:

U

@@ -3147,7 +3147,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

-

Defined in codec/Tuple.ts:72

+

Defined in codec/Tuple.ts:72

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -3156,7 +3156,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

-

Defined in codec/Tuple.ts:79

+

Defined in codec/Tuple.ts:79

description: Returns a hex string representation of the value

Returns: string


@@ -3165,7 +3165,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

-

Defined in codec/Tuple.ts:86

+

Defined in codec/Tuple.ts:86

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

Returns: any


@@ -3183,7 +3183,7 @@

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:95

+

Defined in codec/Tuple.ts:95

description: Returns the string representation of the value

Returns: string


@@ -3191,7 +3191,7 @@

toU8a

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

Inherited from Tuple.toU8a

-

Defined in codec/Tuple.ts:104

+

Defined in codec/Tuple.ts:104

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

Parameters:

@@ -3249,7 +3249,7 @@

<Static> with

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

Inherited from Tuple.with

-

Defined in codec/Tuple.ts:43

+

Defined in codec/Tuple.ts:43

Type parameters:

S : Array<Constructor>

Parameters:

@@ -3312,7 +3312,7 @@ diff --git a/docs/types/classes/_runtimeversion_.runtimeversionapi.md b/docs/types/classes/_runtimeversion_.runtimeversionapi.md index da6fa82872..2a6cff275d 100644 --- a/docs/types/classes/_runtimeversion_.runtimeversionapi.md +++ b/docs/types/classes/_runtimeversion_.runtimeversionapi.md @@ -29,7 +29,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [RuntimeVersion.ts:35](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/RuntimeVersion.ts#L35)* +*Defined in [RuntimeVersion.ts:35](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/RuntimeVersion.ts#L35)* **Parameters:** @@ -67,7 +67,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L65)* +*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L65)* *__description__*: The types definition of the tuple @@ -82,7 +82,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L56)* +*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -95,7 +95,7 @@ ___ getid(): [ApiId](_runtimeversion_.apiid.md) -*Defined in [RuntimeVersion.ts:46](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/RuntimeVersion.ts#L46)* +*Defined in [RuntimeVersion.ts:46](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/RuntimeVersion.ts#L46)* *__description__*: The [ApiId](_runtimeversion_.apiid.md) @@ -108,7 +108,7 @@ ___ getversion(): [U32](_u32_.u32.md) -*Defined in [RuntimeVersion.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/RuntimeVersion.ts#L53)* +*Defined in [RuntimeVersion.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/RuntimeVersion.ts#L53)* *__description__*: The specific version as [U32](_u32_.u32.md) @@ -278,7 +278,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L121)* +*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L121)* *__description__*: Filters the array with the callback @@ -698,7 +698,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L130)* +*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L130)* *__description__*: Maps the array with the callback @@ -1006,7 +1006,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L72)* +*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L72)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1023,7 +1023,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L79)* +*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L79)* *__description__*: Returns a hex string representation of the value @@ -1040,7 +1040,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L86)* +*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L86)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1074,7 +1074,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L95)* +*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L95)* *__description__*: Returns the string representation of the value @@ -1089,7 +1089,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L104)* +*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L104)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1146,7 +1146,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L43)* +*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L43)* **Type parameters:** diff --git a/docs/types/classes/_sessionkey_.sessionkey.html b/docs/types/classes/_sessionkey_.sessionkey.html index 7113fff364..2bcb79b66f 100644 --- a/docs/types/classes/_sessionkey_.sessionkey.html +++ b/docs/types/classes/_sessionkey_.sessionkey.html @@ -1977,7 +1977,7 @@

⊕ new SessionKey(value?: AnyU8a): SessionKey

Inherited from AccountId.constructor

Overrides U8aFixed.constructor

-

Defined in AccountId.ts:19

+

Defined in AccountId.ts:19

Parameters:

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


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

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


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

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2729,7 +2729,7 @@

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

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

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

Parameters:

@@ -2760,7 +2760,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2770,7 +2770,7 @@

Implementation of Codec.toJSON

Inherited from AccountId.toJSON

Overrides U8a.toJSON

-

Defined in AccountId.ts:46

+

Defined in AccountId.ts:46

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

Returns: any


@@ -2788,7 +2788,7 @@

Implementation of Codec.toString

Inherited from AccountId.toString

Overrides U8a.toString

-

Defined in AccountId.ts:53

+

Defined in AccountId.ts:53

description: Returns the string representation of the value

Returns: string


@@ -2796,7 +2796,7 @@

toU8a

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

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

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

Parameters:

@@ -2829,7 +2829,7 @@

<Static> encode

▸ encode(value: Uint8Array): string

Inherited from AccountId.encode

-

Defined in AccountId.ts:27

+

Defined in AccountId.ts:27

Parameters:

@@ -2890,7 +2890,7 @@ diff --git a/docs/types/classes/_sessionkey_.sessionkey.md b/docs/types/classes/_sessionkey_.sessionkey.md index 02b3b3d54a..75d11a60ed 100644 --- a/docs/types/classes/_sessionkey_.sessionkey.md +++ b/docs/types/classes/_sessionkey_.sessionkey.md @@ -29,7 +29,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/AccountId.ts#L19)* +*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/AccountId.ts#L19)* **Parameters:** @@ -117,7 +117,7 @@ getencodedLength(): `number` *Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -134,7 +134,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -165,7 +165,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -691,7 +691,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -715,7 +715,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -734,7 +734,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/AccountId.ts#L46)* +*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/AccountId.ts#L46)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -768,7 +768,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* -*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/AccountId.ts#L53)* +*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/AccountId.ts#L53)* *__description__*: Returns the string representation of the value @@ -783,7 +783,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -819,7 +819,7 @@ ___ *Inherited from [AccountId](_accountid_.accountid.md).[encode](_accountid_.accountid.md#encode)* -*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/AccountId.ts#L27)* +*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/AccountId.ts#L27)* **Parameters:** diff --git a/docs/types/classes/_signature_.signature.html b/docs/types/classes/_signature_.signature.html index c0dcf0e34c..08d7206eb9 100644 --- a/docs/types/classes/_signature_.signature.html +++ b/docs/types/classes/_signature_.signature.html @@ -1978,7 +1978,7 @@

⊕ new Signature(value?: AnyU8a): Signature

Inherited from H512.constructor

Overrides U8aFixed.constructor

-

Defined in H512.ts:14

+

Defined in H512.ts:14

Parameters:

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


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

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


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

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

-

Defined in codec/U8aFixed.ts:39

+

Defined in codec/U8aFixed.ts:39

description: Returns the number of bits in the value

Returns: number


@@ -2728,7 +2728,7 @@

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

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

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

Parameters:

@@ -2759,7 +2759,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2768,7 +2768,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2786,7 +2786,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2794,7 +2794,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from U8a.toU8a

-

Defined in codec/U8a.ts:82

+

Defined in codec/U8a.ts:82

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2866,7 +2866,7 @@ diff --git a/docs/types/classes/_signature_.signature.md b/docs/types/classes/_signature_.signature.md index decd71eeb4..6c3ca25f70 100644 --- a/docs/types/classes/_signature_.signature.md +++ b/docs/types/classes/_signature_.signature.md @@ -31,7 +31,7 @@ *Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* -*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/H512.ts#L14)* +*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/H512.ts#L14)* **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/e79c6d8/packages/types/src/codec/U8a.ts#L36)* +*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L36)* *__description__*: The length of the value when encoded as a Uint8Array @@ -136,7 +136,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -167,7 +167,7 @@ ___ *Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* -*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8aFixed.ts#L39)* +*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8aFixed.ts#L39)* *__description__*: Returns the number of bits in the value @@ -693,7 +693,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -717,7 +717,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -734,7 +734,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -768,7 +768,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -783,7 +783,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L82)* +*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L82)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_signaturepayload_.signaturepayload.html b/docs/types/classes/_signaturepayload_.signaturepayload.html index 3abc13c6d5..b9eeb500be 100644 --- a/docs/types/classes/_signaturepayload_.signaturepayload.html +++ b/docs/types/classes/_signaturepayload_.signaturepayload.html @@ -1980,7 +1980,7 @@

constructor

⊕ new SignaturePayload(value?: SignaturePayloadValue | Uint8Array): SignaturePayload

Overrides Struct.constructor

-

Defined in SignaturePayload.ts:33

+

Defined in SignaturePayload.ts:33

Parameters:

@@ -2016,14 +2016,14 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


blockHash

getblockHash(): Hash

-

Defined in SignaturePayload.ts:54

+

Defined in SignaturePayload.ts:54

description: The block Hash the signature applies to (mortal/immortal)

Returns: Hash


@@ -2031,42 +2031,42 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


era

getera(): ExtrinsicEra

-

Defined in SignaturePayload.ts:68

+

Defined in SignaturePayload.ts:68

description: The ExtrinsicEra

Returns: ExtrinsicEra


isSigned

getisSigned(): boolean

-

Defined in SignaturePayload.ts:47

+

Defined in SignaturePayload.ts:47

description: true if the payload refers to a valid signature

Returns: boolean


method

getmethod(): Method

-

Defined in SignaturePayload.ts:61

+

Defined in SignaturePayload.ts:61

description: The Method contained in the payload

Returns: Method


nonce

getnonce(): Nonce

-

Defined in SignaturePayload.ts:75

+

Defined in SignaturePayload.ts:75

description: The Nonce

Returns: Nonce


signature

getsignature(): Uint8Array

-

Defined in SignaturePayload.ts:82

+

Defined in SignaturePayload.ts:82

description: The raw signature as a Uint8Array

Returns: Uint8Array


@@ -2147,7 +2147,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2172,7 +2172,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2250,7 +2250,7 @@

sign

▸ sign(signerPair: KeyringPair): Uint8Array

-

Defined in SignaturePayload.ts:93

+

Defined in SignaturePayload.ts:93

description: Sign the payload with the keypair

Parameters:

@@ -2273,7 +2273,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2282,7 +2282,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2291,7 +2291,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2300,7 +2300,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2308,7 +2308,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2341,7 +2341,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2404,7 +2404,7 @@ diff --git a/docs/types/classes/_signaturepayload_.signaturepayload.md b/docs/types/classes/_signaturepayload_.signaturepayload.md index c12dd6f2d5..740fb41325 100644 --- a/docs/types/classes/_signaturepayload_.signaturepayload.md +++ b/docs/types/classes/_signaturepayload_.signaturepayload.md @@ -31,7 +31,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [SignaturePayload.ts:33](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/SignaturePayload.ts#L33)* +*Defined in [SignaturePayload.ts:33](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/SignaturePayload.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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -91,7 +91,7 @@ ___ getblockHash(): [Hash](_hash_.hash.md) -*Defined in [SignaturePayload.ts:54](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/SignaturePayload.ts#L54)* +*Defined in [SignaturePayload.ts:54](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/SignaturePayload.ts#L54)* *__description__*: The block [Hash](_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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -119,7 +119,7 @@ ___ getera(): [ExtrinsicEra](_extrinsicera_.extrinsicera.md) -*Defined in [SignaturePayload.ts:68](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/SignaturePayload.ts#L68)* +*Defined in [SignaturePayload.ts:68](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/SignaturePayload.ts#L68)* *__description__*: The [ExtrinsicEra](_extrinsicera_.extrinsicera.md) @@ -132,7 +132,7 @@ ___ getisSigned(): `boolean` -*Defined in [SignaturePayload.ts:47](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/SignaturePayload.ts#L47)* +*Defined in [SignaturePayload.ts:47](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/SignaturePayload.ts#L47)* *__description__*: `true` if the payload refers to a valid signature @@ -145,7 +145,7 @@ ___ getmethod(): [Method](_method_.method.md) -*Defined in [SignaturePayload.ts:61](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/SignaturePayload.ts#L61)* +*Defined in [SignaturePayload.ts:61](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/SignaturePayload.ts#L61)* *__description__*: The [Method](_method_.method.md) contained in the payload @@ -158,7 +158,7 @@ ___ getnonce(): [Nonce](_nonce_.nonce.md) -*Defined in [SignaturePayload.ts:75](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/SignaturePayload.ts#L75)* +*Defined in [SignaturePayload.ts:75](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/SignaturePayload.ts#L75)* *__description__*: The [Nonce](_nonce_.nonce.md) @@ -171,7 +171,7 @@ ___ getsignature(): `Uint8Array` -*Defined in [SignaturePayload.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/SignaturePayload.ts#L82)* +*Defined in [SignaturePayload.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/SignaturePayload.ts#L82)* *__description__*: The raw signature as a `Uint8Array` @@ -273,7 +273,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -294,7 +294,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -367,7 +367,7 @@ ___ ▸ **sign**(signerPair: *`KeyringPair`*): `Uint8Array` -*Defined in [SignaturePayload.ts:93](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/SignaturePayload.ts#L93)* +*Defined in [SignaturePayload.ts:93](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/SignaturePayload.ts#L93)* *__description__*: Sign the payload with the keypair @@ -388,7 +388,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__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:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__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:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__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:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -454,7 +454,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -490,7 +490,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_signedblock_.signedblock.html b/docs/types/classes/_signedblock_.signedblock.html index 389d358642..ba78bf9af8 100644 --- a/docs/types/classes/_signedblock_.signedblock.html +++ b/docs/types/classes/_signedblock_.signedblock.html @@ -1979,7 +1979,7 @@

constructor

⊕ new SignedBlock(value?: SignedBlockValue | Uint8Array): SignedBlock

Overrides Struct.constructor

-

Defined in SignedBlock.ts:21

+

Defined in SignedBlock.ts:21

Parameters:

@@ -2015,14 +2015,14 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


block

getblock(): Block

-

Defined in SignedBlock.ts:32

+

Defined in SignedBlock.ts:32

description: The wrapped Block

Returns: Block


@@ -2030,14 +2030,14 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


justification

getjustification(): Justification

-

Defined in SignedBlock.ts:39

+

Defined in SignedBlock.ts:39

description: The wrapped Justification

Returns: Justification


@@ -2118,7 +2118,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2143,7 +2143,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2222,7 +2222,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2231,7 +2231,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2240,7 +2240,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2249,7 +2249,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2257,7 +2257,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2290,7 +2290,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2353,7 +2353,7 @@ diff --git a/docs/types/classes/_signedblock_.signedblock.md b/docs/types/classes/_signedblock_.signedblock.md index da6ef054db..688d1d763b 100644 --- a/docs/types/classes/_signedblock_.signedblock.md +++ b/docs/types/classes/_signedblock_.signedblock.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [SignedBlock.ts:21](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/SignedBlock.ts#L21)* +*Defined in [SignedBlock.ts:21](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/SignedBlock.ts#L21)* **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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -89,7 +89,7 @@ ___ getblock(): [Block](_block_.block.md) -*Defined in [SignedBlock.ts:32](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/SignedBlock.ts#L32)* +*Defined in [SignedBlock.ts:32](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/SignedBlock.ts#L32)* *__description__*: The wrapped [Block](_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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -117,7 +117,7 @@ ___ getjustification(): [Justification](_justification_.justification.md) -*Defined in [SignedBlock.ts:39](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/SignedBlock.ts#L39)* +*Defined in [SignedBlock.ts:39](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/SignedBlock.ts#L39)* *__description__*: The wrapped [Justification](_justification_.justification.md) @@ -219,7 +219,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -240,7 +240,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -315,7 +315,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -332,7 +332,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -381,7 +381,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -417,7 +417,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_storagechangeset_.storagechangeset.html b/docs/types/classes/_storagechangeset_.storagechangeset.html index e935fb9688..8d4f440446 100644 --- a/docs/types/classes/_storagechangeset_.storagechangeset.html +++ b/docs/types/classes/_storagechangeset_.storagechangeset.html @@ -1979,7 +1979,7 @@

constructor

⊕ new StorageChangeSet(value?: StorageChangeSetValue | Uint8Array): StorageChangeSet

Overrides Struct.constructor

-

Defined in StorageChangeSet.ts:24

+

Defined in StorageChangeSet.ts:24

Parameters:

@@ -2015,21 +2015,21 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


block

getblock(): Hash

-

Defined in StorageChangeSet.ts:42

+

Defined in StorageChangeSet.ts:42

description: The block Hash

Returns: Hash


changes

getchanges(): Vector<KeyValueOption>

-

Defined in StorageChangeSet.ts:35

+

Defined in StorageChangeSet.ts:35

description: The applicable changes as KeyValueOption

Returns: Vector<KeyValueOption>


@@ -2037,7 +2037,7 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2118,7 +2118,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2143,7 +2143,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2222,7 +2222,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2231,7 +2231,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2240,7 +2240,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2249,7 +2249,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2257,7 +2257,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2290,7 +2290,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2353,7 +2353,7 @@ diff --git a/docs/types/classes/_storagechangeset_.storagechangeset.md b/docs/types/classes/_storagechangeset_.storagechangeset.md index 62b02b065a..735af2ac6a 100644 --- a/docs/types/classes/_storagechangeset_.storagechangeset.md +++ b/docs/types/classes/_storagechangeset_.storagechangeset.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [StorageChangeSet.ts:24](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StorageChangeSet.ts#L24)* +*Defined in [StorageChangeSet.ts:24](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -89,7 +89,7 @@ ___ getblock(): [Hash](_hash_.hash.md) -*Defined in [StorageChangeSet.ts:42](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StorageChangeSet.ts#L42)* +*Defined in [StorageChangeSet.ts:42](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StorageChangeSet.ts#L42)* *__description__*: The block [Hash](_hash_.hash.md) @@ -102,7 +102,7 @@ ___ getchanges(): [Vector](_codec_vector_.vector.md)<[KeyValueOption](_keyvalue_.keyvalueoption.md)> -*Defined in [StorageChangeSet.ts:35](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StorageChangeSet.ts#L35)* +*Defined in [StorageChangeSet.ts:35](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StorageChangeSet.ts#L35)* *__description__*: The applicable changes as [KeyValueOption](_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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -219,7 +219,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -240,7 +240,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -315,7 +315,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -332,7 +332,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -381,7 +381,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -417,7 +417,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_storagedata_.storagedata.html b/docs/types/classes/_storagedata_.storagedata.html index 14a1f4025d..76622832c5 100644 --- a/docs/types/classes/_storagedata_.storagedata.html +++ b/docs/types/classes/_storagedata_.storagedata.html @@ -1977,7 +1977,7 @@

⊕ new StorageData(value: AnyU8a): StorageData

Inherited from Bytes.constructor

Overrides U8a.constructor

-

Defined in Bytes.ts:18

+

Defined in Bytes.ts:18

Parameters:

@@ -2036,7 +2036,7 @@

getencodedLength(): number

Inherited from Bytes.encodedLength

Overrides U8a.encodedLength

-

Defined in Bytes.ts:64

+

Defined in Bytes.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2045,7 +2045,7 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


@@ -2720,7 +2720,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2751,7 +2751,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2760,7 +2760,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2778,7 +2778,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2787,7 +2787,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Bytes.toU8a

Overrides U8a.toU8a

-

Defined in Bytes.ts:72

+

Defined in Bytes.ts:72

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2859,7 +2859,7 @@ diff --git a/docs/types/classes/_storagedata_.storagedata.md b/docs/types/classes/_storagedata_.storagedata.md index c3537a4eaa..8cbda4dda7 100644 --- a/docs/types/classes/_storagedata_.storagedata.md +++ b/docs/types/classes/_storagedata_.storagedata.md @@ -29,7 +29,7 @@ *Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* -*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bytes.ts#L18)* +*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bytes.ts#L18)* **Parameters:** @@ -119,7 +119,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bytes.ts#L64)* +*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bytes.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -136,7 +136,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -678,7 +678,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -702,7 +702,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -719,7 +719,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -753,7 +753,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -770,7 +770,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bytes.ts#L72)* +*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bytes.ts#L72)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_storagekey_.storagekey.html b/docs/types/classes/_storagekey_.storagekey.html index 425bc6571e..1652a9a6f7 100644 --- a/docs/types/classes/_storagekey_.storagekey.html +++ b/docs/types/classes/_storagekey_.storagekey.html @@ -1976,7 +1976,7 @@

constructor

⊕ new StorageKey(value: AnyU8a | StorageKey | StorageFunction | [StorageFunction, any]): StorageKey

Overrides Bytes.constructor

-

Defined in StorageKey.ts:27

+

Defined in StorageKey.ts:27

Parameters:

@@ -2035,7 +2035,7 @@

getencodedLength(): number

Inherited from Bytes.encodedLength

Overrides U8a.encodedLength

-

Defined in Bytes.ts:64

+

Defined in Bytes.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2044,14 +2044,14 @@

getlength(): number

Inherited from U8a.length

Overrides Uint8Array.length

-

Defined in codec/U8a.ts:43

+

Defined in codec/U8a.ts:43

description: The length of the value

Returns: number


outputType

getoutputType(): string | null

-

Defined in StorageKey.ts:66

+

Defined in StorageKey.ts:66

description: The output type, null when not available

Returns: string | null


@@ -2726,7 +2726,7 @@

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

-

Defined in codec/U8a.ts:53

+

Defined in codec/U8a.ts:53

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

@@ -2757,7 +2757,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

-

Defined in codec/U8a.ts:60

+

Defined in codec/U8a.ts:60

description: Returns a hex string representation of the value

Returns: string


@@ -2766,7 +2766,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

-

Defined in codec/U8a.ts:67

+

Defined in codec/U8a.ts:67

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2784,7 +2784,7 @@

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

-

Defined in codec/U8a.ts:74

+

Defined in codec/U8a.ts:74

description: Returns the string representation of the value

Returns: string


@@ -2793,7 +2793,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Bytes.toU8a

Overrides U8a.toU8a

-

Defined in Bytes.ts:72

+

Defined in Bytes.ts:72

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2825,7 +2825,7 @@

<Static> decodeStorageKey

▸ decodeStorageKey(value: AnyU8a | StorageKey | StorageFunction | [StorageFunction, any]): Uint8Array

-

Defined in StorageKey.ts:35

+

Defined in StorageKey.ts:35

Parameters:

@@ -2846,7 +2846,7 @@

<Static> getType

▸ getType(value: StorageKey | StorageFunction | [StorageFunction, any]): string | null

-

Defined in StorageKey.ts:49

+

Defined in StorageKey.ts:49

Parameters:

@@ -2907,7 +2907,7 @@ diff --git a/docs/types/classes/_storagekey_.storagekey.md b/docs/types/classes/_storagekey_.storagekey.md index d7ada11c82..e746e3882e 100644 --- a/docs/types/classes/_storagekey_.storagekey.md +++ b/docs/types/classes/_storagekey_.storagekey.md @@ -27,7 +27,7 @@ *Overrides [Bytes](_bytes_.bytes.md).[constructor](_bytes_.bytes.md#constructor)* -*Defined in [StorageKey.ts:27](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StorageKey.ts#L27)* +*Defined in [StorageKey.ts:27](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StorageKey.ts#L27)* **Parameters:** @@ -117,7 +117,7 @@ getencodedLength(): `number` *Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* -*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bytes.ts#L64)* +*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bytes.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -134,7 +134,7 @@ getlength(): `number` *Overrides Uint8Array.length* -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L43)* +*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L43)* *__description__*: The length of the value @@ -147,7 +147,7 @@ ___ getoutputType(): `string` | `null` -*Defined in [StorageKey.ts:66](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StorageKey.ts#L66)* +*Defined in [StorageKey.ts:66](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StorageKey.ts#L66)* *__description__*: The output type, `null` when not available @@ -689,7 +689,7 @@ ___ *Overrides Uint8Array.subarray* -*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L53)* +*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L53)* *__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here @@ -713,7 +713,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* -*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L60)* +*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L60)* *__description__*: Returns a hex string representation of the value @@ -730,7 +730,7 @@ ___ *Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* -*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L67)* +*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L67)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -764,7 +764,7 @@ ___ *Overrides Uint8Array.toString* -*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/U8a.ts#L74)* +*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/U8a.ts#L74)* *__description__*: Returns the string representation of the value @@ -781,7 +781,7 @@ ___ *Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* -*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bytes.ts#L72)* +*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bytes.ts#L72)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -815,7 +815,7 @@ ___ ▸ **decodeStorageKey**(value: * [AnyU8a](../modules/_types_.md#anyu8a) | [StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]*): `Uint8Array` -*Defined in [StorageKey.ts:35](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StorageKey.ts#L35)* +*Defined in [StorageKey.ts:35](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StorageKey.ts#L35)* **Parameters:** @@ -832,7 +832,7 @@ ___ ▸ **getType**(value: * [StorageKey](_storagekey_.storagekey.md) | [StorageFunction](../interfaces/_storagekey_.storagefunction.md) | [[StorageFunction](../interfaces/_storagekey_.storagefunction.md), `any`]*): `string` | `null` -*Defined in [StorageKey.ts:49](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StorageKey.ts#L49)* +*Defined in [StorageKey.ts:49](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StorageKey.ts#L49)* **Parameters:** diff --git a/docs/types/classes/_storedpendingchange_.nextauthority.html b/docs/types/classes/_storedpendingchange_.nextauthority.html index baa686d538..5a9d658ad9 100644 --- a/docs/types/classes/_storedpendingchange_.nextauthority.html +++ b/docs/types/classes/_storedpendingchange_.nextauthority.html @@ -1978,7 +1978,7 @@

constructor

⊕ new NextAuthority(value?: Uint8Array | NextAuthorityValue): NextAuthority

Overrides Tuple.constructor

-

Defined in StoredPendingChange.ts:31

+

Defined in StoredPendingChange.ts:31

Parameters:

@@ -2009,7 +2009,7 @@

Types

getTypes(): Array<string>

Inherited from Tuple.Types

-

Defined in codec/Tuple.ts:65

+

Defined in codec/Tuple.ts:65

description: The types definition of the tuple

Returns: Array<string>


@@ -2017,20 +2017,20 @@

encodedLength

getencodedLength(): number

Inherited from Tuple.encodedLength

-

Defined in codec/Tuple.ts:56

+

Defined in codec/Tuple.ts:56

description: The length of the value when encoded as a Uint8Array

Returns: number


index

getindex(): U64

-

Defined in StoredPendingChange.ts:39

+

Defined in StoredPendingChange.ts:39

Returns: U64


sessionKey

getsessionKey(): SessionKey

-

Defined in StoredPendingChange.ts:43

+

Defined in StoredPendingChange.ts:43

Returns: SessionKey


Methods

@@ -2210,7 +2210,7 @@

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Inherited from Tuple.filter

Overrides Array.filter

-

Defined in codec/Tuple.ts:121

+

Defined in codec/Tuple.ts:121

description: Filters the array with the callback

Parameters:

@@ -2763,7 +2763,7 @@

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Tuple.map

Overrides Array.map

-

Defined in codec/Tuple.ts:130

+

Defined in codec/Tuple.ts:130

description: Maps the array with the callback

Type parameters:

U

@@ -3145,7 +3145,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

-

Defined in codec/Tuple.ts:72

+

Defined in codec/Tuple.ts:72

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -3154,7 +3154,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

-

Defined in codec/Tuple.ts:79

+

Defined in codec/Tuple.ts:79

description: Returns a hex string representation of the value

Returns: string


@@ -3163,7 +3163,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

-

Defined in codec/Tuple.ts:86

+

Defined in codec/Tuple.ts:86

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -3181,7 +3181,7 @@

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

-

Defined in codec/Tuple.ts:95

+

Defined in codec/Tuple.ts:95

description: Returns the string representation of the value

Returns: string


@@ -3189,7 +3189,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Tuple.toU8a

-

Defined in codec/Tuple.ts:104

+

Defined in codec/Tuple.ts:104

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -3247,7 +3247,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Tuple<S>>

Inherited from Tuple.with

-

Defined in codec/Tuple.ts:43

+

Defined in codec/Tuple.ts:43

Type parameters:

S : Array<Constructor>

Parameters:

@@ -3310,7 +3310,7 @@ diff --git a/docs/types/classes/_storedpendingchange_.nextauthority.md b/docs/types/classes/_storedpendingchange_.nextauthority.md index 7b69c350c8..b5c0eec1d3 100644 --- a/docs/types/classes/_storedpendingchange_.nextauthority.md +++ b/docs/types/classes/_storedpendingchange_.nextauthority.md @@ -29,7 +29,7 @@ *Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* -*Defined in [StoredPendingChange.ts:31](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StoredPendingChange.ts#L31)* +*Defined in [StoredPendingChange.ts:31](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StoredPendingChange.ts#L31)* **Parameters:** @@ -67,7 +67,7 @@ getTypes(): `Array`<`string`> *Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* -*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L65)* +*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L65)* *__description__*: The types definition of the tuple @@ -82,7 +82,7 @@ getencodedLength(): `number` *Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* -*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L56)* +*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -95,7 +95,7 @@ ___ getindex(): [U64](_u64_.u64.md) -*Defined in [StoredPendingChange.ts:39](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StoredPendingChange.ts#L39)* +*Defined in [StoredPendingChange.ts:39](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StoredPendingChange.ts#L39)* **Returns:** [U64](_u64_.u64.md) @@ -106,7 +106,7 @@ ___ getsessionKey(): [SessionKey](_sessionkey_.sessionkey.md) -*Defined in [StoredPendingChange.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StoredPendingChange.ts#L43)* +*Defined in [StoredPendingChange.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StoredPendingChange.ts#L43)* **Returns:** [SessionKey](_sessionkey_.sessionkey.md) @@ -274,7 +274,7 @@ ___ *Overrides Array.filter* -*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L121)* +*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L121)* *__description__*: Filters the array with the callback @@ -694,7 +694,7 @@ ___ *Overrides Array.map* -*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L130)* +*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L130)* *__description__*: Maps the array with the callback @@ -1002,7 +1002,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* -*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L72)* +*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L72)* *__description__*: Converts the Object to an standard JavaScript Array @@ -1019,7 +1019,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* -*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L79)* +*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L79)* *__description__*: Returns a hex string representation of the value @@ -1036,7 +1036,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* -*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L86)* +*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L86)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1070,7 +1070,7 @@ ___ *Overrides Array.toString* -*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L95)* +*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L95)* *__description__*: Returns the string representation of the value @@ -1085,7 +1085,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* -*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L104)* +*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L104)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1142,7 +1142,7 @@ ___ *Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* -*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Tuple.ts#L43)* +*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Tuple.ts#L43)* **Type parameters:** diff --git a/docs/types/classes/_storedpendingchange_.storedpendingchange.html b/docs/types/classes/_storedpendingchange_.storedpendingchange.html index 81395abe1c..8f2789a844 100644 --- a/docs/types/classes/_storedpendingchange_.storedpendingchange.html +++ b/docs/types/classes/_storedpendingchange_.storedpendingchange.html @@ -1979,7 +1979,7 @@

constructor

⊕ new StoredPendingChange(value?: Uint8Array | StoredPendingChangeValue): StoredPendingChange

Overrides Struct.constructor

-

Defined in StoredPendingChange.ts:53

+

Defined in StoredPendingChange.ts:53

Parameters:

@@ -2015,34 +2015,34 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


delay

getdelay(): BlockNumber

-

Defined in StoredPendingChange.ts:65

+

Defined in StoredPendingChange.ts:65

Returns: BlockNumber


encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


nextAuthorities

getnextAuthorities(): Vector<NextAuthority>

-

Defined in StoredPendingChange.ts:69

+

Defined in StoredPendingChange.ts:69

Returns: Vector<NextAuthority>


scheduledAt

getscheduledAt(): BlockNumber

-

Defined in StoredPendingChange.ts:73

+

Defined in StoredPendingChange.ts:73

Returns: BlockNumber


Methods

@@ -2122,7 +2122,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2147,7 +2147,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2226,7 +2226,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2235,7 +2235,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2244,7 +2244,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2253,7 +2253,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2261,7 +2261,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2294,7 +2294,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2357,7 +2357,7 @@ diff --git a/docs/types/classes/_storedpendingchange_.storedpendingchange.md b/docs/types/classes/_storedpendingchange_.storedpendingchange.md index 5260c86659..f481b7cd0e 100644 --- a/docs/types/classes/_storedpendingchange_.storedpendingchange.md +++ b/docs/types/classes/_storedpendingchange_.storedpendingchange.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [StoredPendingChange.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StoredPendingChange.ts#L53)* +*Defined in [StoredPendingChange.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StoredPendingChange.ts#L53)* **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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__description__*: Returns the Type description to sthe structure @@ -89,7 +89,7 @@ ___ getdelay(): [BlockNumber](_blocknumber_.blocknumber.md) -*Defined in [StoredPendingChange.ts:65](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StoredPendingChange.ts#L65)* +*Defined in [StoredPendingChange.ts:65](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StoredPendingChange.ts#L65)* **Returns:** [BlockNumber](_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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -115,7 +115,7 @@ ___ getnextAuthorities(): [Vector](_codec_vector_.vector.md)<[NextAuthority](_storedpendingchange_.nextauthority.md)> -*Defined in [StoredPendingChange.ts:69](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StoredPendingChange.ts#L69)* +*Defined in [StoredPendingChange.ts:69](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StoredPendingChange.ts#L69)* **Returns:** [Vector](_codec_vector_.vector.md)<[NextAuthority](_storedpendingchange_.nextauthority.md)> @@ -126,7 +126,7 @@ ___ getscheduledAt(): [BlockNumber](_blocknumber_.blocknumber.md) -*Defined in [StoredPendingChange.ts:73](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StoredPendingChange.ts#L73)* +*Defined in [StoredPendingChange.ts:73](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StoredPendingChange.ts#L73)* **Returns:** [BlockNumber](_blocknumber_.blocknumber.md) @@ -226,7 +226,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -247,7 +247,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -322,7 +322,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -339,7 +339,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -356,7 +356,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -373,7 +373,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -388,7 +388,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -424,7 +424,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_text_.text.html b/docs/types/classes/_text_.text.html index 750522cd7c..4ed7faeb24 100644 --- a/docs/types/classes/_text_.text.html +++ b/docs/types/classes/_text_.text.html @@ -1976,7 +1976,7 @@

constructor

⊕ new Text(value?: Text | string | AnyU8a | object): Text

-

Defined in Text.ts:23

+

Defined in Text.ts:23

Parameters:

@@ -2007,7 +2007,7 @@

encodedLength

getencodedLength(): number

-

Defined in Text.ts:47

+

Defined in Text.ts:47

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2015,7 +2015,7 @@

length

getlength(): number

Overrides String.length

-

Defined in Text.ts:54

+

Defined in Text.ts:54

description: The length of the value

Returns: number


@@ -2024,7 +2024,7 @@

toHex

▸ toHex(): string

Implementation of Codec.toHex

-

Defined in Text.ts:62

+

Defined in Text.ts:62

description: Returns a hex string representation of the value

Returns: string


@@ -2032,7 +2032,7 @@

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

-

Defined in Text.ts:69

+

Defined in Text.ts:69

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2041,14 +2041,14 @@

▸ toString(): string

Implementation of Codec.toString

Overrides String.toString

-

Defined in Text.ts:76

+

Defined in Text.ts:76

description: Returns the string representation of the value

Returns: string


toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

-

Defined in Text.ts:85

+

Defined in Text.ts:85

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2112,7 +2112,7 @@ diff --git a/docs/types/classes/_text_.text.md b/docs/types/classes/_text_.text.md index d0f79d1979..2839528935 100644 --- a/docs/types/classes/_text_.text.md +++ b/docs/types/classes/_text_.text.md @@ -27,7 +27,7 @@ ⊕ **new Text**(value?: * [Text](_text_.text.md) | `string` | [AnyU8a](../modules/_types_.md#anyu8a) | `object`*): [Text](_text_.text.md) -*Defined in [Text.ts:23](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Text.ts#L23)* +*Defined in [Text.ts:23](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Text.ts#L23)* **Parameters:** @@ -61,7 +61,7 @@ ___ getencodedLength(): `number` -*Defined in [Text.ts:47](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Text.ts#L47)* +*Defined in [Text.ts:47](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Text.ts#L47)* *__description__*: The length of the value when encoded as a Uint8Array @@ -76,7 +76,7 @@ getlength(): `number` *Overrides String.length* -*Defined in [Text.ts:54](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Text.ts#L54)* +*Defined in [Text.ts:54](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Text.ts#L54)* *__description__*: The length of the value @@ -94,7 +94,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* -*Defined in [Text.ts:62](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Text.ts#L62)* +*Defined in [Text.ts:62](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Text.ts#L62)* *__description__*: Returns a hex string representation of the value @@ -109,7 +109,7 @@ ___ *Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* -*Defined in [Text.ts:69](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Text.ts#L69)* +*Defined in [Text.ts:69](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Text.ts#L69)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -126,7 +126,7 @@ ___ *Overrides String.toString* -*Defined in [Text.ts:76](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Text.ts#L76)* +*Defined in [Text.ts:76](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Text.ts#L76)* *__description__*: Returns the string representation of the value @@ -139,7 +139,7 @@ ___ ▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*): `Uint8Array` -*Defined in [Text.ts:85](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Text.ts#L85)* +*Defined in [Text.ts:85](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Text.ts#L85)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_type_.type.html b/docs/types/classes/_type_.type.html index 977a6457fb..f3ec3c3bdd 100644 --- a/docs/types/classes/_type_.type.html +++ b/docs/types/classes/_type_.type.html @@ -1976,7 +1976,7 @@

constructor

⊕ new Type(value?: Text | Uint8Array | string): Type

Overrides Text.constructor

-

Defined in Type.ts:19

+

Defined in Type.ts:19

Parameters:

@@ -2001,7 +2001,7 @@

encodedLength

getencodedLength(): number

Overrides Text.encodedLength

-

Defined in Type.ts:70

+

Defined in Type.ts:70

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2010,7 +2010,7 @@

getlength(): number

Inherited from Text.length

Overrides String.length

-

Defined in Text.ts:54

+

Defined in Text.ts:54

description: The length of the value

Returns: number


@@ -2844,7 +2844,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Text.toHex

-

Defined in Text.ts:62

+

Defined in Text.ts:62

description: Returns a hex string representation of the value

Returns: string


@@ -2853,7 +2853,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Text.toJSON

-

Defined in Text.ts:69

+

Defined in Text.ts:69

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2887,7 +2887,7 @@

Implementation of Codec.toString

Inherited from Text.toString

Overrides String.toString

-

Defined in Text.ts:76

+

Defined in Text.ts:76

description: Returns the string representation of the value

Returns: string


@@ -2895,7 +2895,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Overrides Text.toU8a

-

Defined in Type.ts:81

+

Defined in Type.ts:81

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2999,7 +2999,7 @@ diff --git a/docs/types/classes/_type_.type.md b/docs/types/classes/_type_.type.md index 1c688b316c..93991aa597 100644 --- a/docs/types/classes/_type_.type.md +++ b/docs/types/classes/_type_.type.md @@ -27,7 +27,7 @@ *Overrides [Text](_text_.text.md).[constructor](_text_.text.md#constructor)* -*Defined in [Type.ts:19](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Type.ts#L19)* +*Defined in [Type.ts:19](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Type.ts#L19)* **Parameters:** @@ -49,7 +49,7 @@ getencodedLength(): `number` *Overrides [Text](_text_.text.md).[encodedLength](_text_.text.md#encodedlength)* -*Defined in [Type.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Type.ts#L70)* +*Defined in [Type.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Type.ts#L70)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ getlength(): `number` *Overrides String.length* -*Defined in [Text.ts:54](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Text.ts#L54)* +*Defined in [Text.ts:54](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Text.ts#L54)* *__description__*: The length of the value @@ -832,7 +832,7 @@ ___ *Inherited from [Text](_text_.text.md).[toHex](_text_.text.md#tohex)* -*Defined in [Text.ts:62](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Text.ts#L62)* +*Defined in [Text.ts:62](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Text.ts#L62)* *__description__*: Returns a hex string representation of the value @@ -849,7 +849,7 @@ ___ *Inherited from [Text](_text_.text.md).[toJSON](_text_.text.md#tojson)* -*Defined in [Text.ts:69](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Text.ts#L69)* +*Defined in [Text.ts:69](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Text.ts#L69)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -913,7 +913,7 @@ ___ *Overrides String.toString* -*Defined in [Text.ts:76](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Text.ts#L76)* +*Defined in [Text.ts:76](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Text.ts#L76)* *__description__*: Returns the string representation of the value @@ -928,7 +928,7 @@ ___ *Overrides [Text](_text_.text.md).[toU8a](_text_.text.md#tou8a)* -*Defined in [Type.ts:81](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Type.ts#L81)* +*Defined in [Type.ts:81](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Type.ts#L81)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/classes/_u128_.u128.html b/docs/types/classes/_u128_.u128.html index f98bc7cd3b..eac2379a1e 100644 --- a/docs/types/classes/_u128_.u128.html +++ b/docs/types/classes/_u128_.u128.html @@ -1975,7 +1975,7 @@

constructor

⊕ new U128(value?: AnyNumber): U128

Overrides UInt.constructor

-

Defined in U128.ts:14

+

Defined in U128.ts:14

Parameters:

@@ -1998,7 +1998,7 @@

encodedLength

getencodedLength(): number

Inherited from AbstractInt.encodedLength

-

Defined in codec/AbstractInt.ts:56

+

Defined in codec/AbstractInt.ts:56

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2131,7 +2131,7 @@

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

-

Defined in codec/AbstractInt.ts:63

+

Defined in codec/AbstractInt.ts:63

description: Returns the number of bits in the value

Returns: UIntBitLength


@@ -3509,7 +3509,7 @@

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

-

Defined in codec/AbstractInt.ts:70

+

Defined in codec/AbstractInt.ts:70

description: Returns the BN representation of the number. (Compatibility)

Returns: BN


@@ -3546,7 +3546,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -3556,7 +3556,7 @@

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

-

Defined in codec/AbstractInt.ts:82

+

Defined in codec/AbstractInt.ts:82

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -3596,7 +3596,7 @@

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

-

Defined in codec/AbstractInt.ts:92

+

Defined in codec/AbstractInt.ts:92

description: Returns the string representation of the value

Parameters:

@@ -3645,7 +3645,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -3862,7 +3862,7 @@

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

-

Defined in codec/AbstractInt.ts:37

+

Defined in codec/AbstractInt.ts:37

Parameters:

@@ -4054,7 +4054,7 @@ diff --git a/docs/types/classes/_u128_.u128.md b/docs/types/classes/_u128_.u128.md index 2d50d7bda4..7ff9f1e6c3 100644 --- a/docs/types/classes/_u128_.u128.md +++ b/docs/types/classes/_u128_.u128.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/U128.ts#L14)* +*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/U128.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -188,7 +188,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1523,7 +1523,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1564,7 +1564,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1583,7 +1583,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1636,7 +1636,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1680,7 +1680,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1884,7 +1884,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_u16_.u16.html b/docs/types/classes/_u16_.u16.html index ff6b264eb4..9e6581827a 100644 --- a/docs/types/classes/_u16_.u16.html +++ b/docs/types/classes/_u16_.u16.html @@ -1974,7 +1974,7 @@

constructor

⊕ new U16(value?: AnyNumber): U16

Overrides UInt.constructor

-

Defined in U16.ts:14

+

Defined in U16.ts:14

Parameters:

@@ -1997,7 +1997,7 @@

encodedLength

getencodedLength(): number

Inherited from AbstractInt.encodedLength

-

Defined in codec/AbstractInt.ts:56

+

Defined in codec/AbstractInt.ts:56

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2130,7 +2130,7 @@

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

-

Defined in codec/AbstractInt.ts:63

+

Defined in codec/AbstractInt.ts:63

description: Returns the number of bits in the value

Returns: UIntBitLength


@@ -3508,7 +3508,7 @@

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

-

Defined in codec/AbstractInt.ts:70

+

Defined in codec/AbstractInt.ts:70

description: Returns the BN representation of the number. (Compatibility)

Returns: BN


@@ -3545,7 +3545,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -3555,7 +3555,7 @@

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

-

Defined in codec/AbstractInt.ts:82

+

Defined in codec/AbstractInt.ts:82

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -3595,7 +3595,7 @@

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

-

Defined in codec/AbstractInt.ts:92

+

Defined in codec/AbstractInt.ts:92

description: Returns the string representation of the value

Parameters:

@@ -3644,7 +3644,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -3861,7 +3861,7 @@

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

-

Defined in codec/AbstractInt.ts:37

+

Defined in codec/AbstractInt.ts:37

Parameters:

@@ -4053,7 +4053,7 @@ diff --git a/docs/types/classes/_u16_.u16.md b/docs/types/classes/_u16_.u16.md index 15badeb5fd..4a953ec25d 100644 --- a/docs/types/classes/_u16_.u16.md +++ b/docs/types/classes/_u16_.u16.md @@ -24,7 +24,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U16.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/U16.ts#L14)* +*Defined in [U16.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/U16.ts#L14)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -186,7 +186,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1521,7 +1521,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1562,7 +1562,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1581,7 +1581,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1634,7 +1634,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1678,7 +1678,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1882,7 +1882,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_u256_.u256.html b/docs/types/classes/_u256_.u256.html index 12949c394f..24c62073a9 100644 --- a/docs/types/classes/_u256_.u256.html +++ b/docs/types/classes/_u256_.u256.html @@ -1974,7 +1974,7 @@

constructor

⊕ new U256(value?: AnyNumber): U256

Overrides UInt.constructor

-

Defined in U256.ts:14

+

Defined in U256.ts:14

Parameters:

@@ -1997,7 +1997,7 @@

encodedLength

getencodedLength(): number

Inherited from AbstractInt.encodedLength

-

Defined in codec/AbstractInt.ts:56

+

Defined in codec/AbstractInt.ts:56

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2130,7 +2130,7 @@

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

-

Defined in codec/AbstractInt.ts:63

+

Defined in codec/AbstractInt.ts:63

description: Returns the number of bits in the value

Returns: UIntBitLength


@@ -3508,7 +3508,7 @@

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

-

Defined in codec/AbstractInt.ts:70

+

Defined in codec/AbstractInt.ts:70

description: Returns the BN representation of the number. (Compatibility)

Returns: BN


@@ -3545,7 +3545,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -3555,7 +3555,7 @@

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

-

Defined in codec/AbstractInt.ts:82

+

Defined in codec/AbstractInt.ts:82

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -3595,7 +3595,7 @@

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

-

Defined in codec/AbstractInt.ts:92

+

Defined in codec/AbstractInt.ts:92

description: Returns the string representation of the value

Parameters:

@@ -3644,7 +3644,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -3861,7 +3861,7 @@

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

-

Defined in codec/AbstractInt.ts:37

+

Defined in codec/AbstractInt.ts:37

Parameters:

@@ -4053,7 +4053,7 @@ diff --git a/docs/types/classes/_u256_.u256.md b/docs/types/classes/_u256_.u256.md index 4819f2590e..9be09d2636 100644 --- a/docs/types/classes/_u256_.u256.md +++ b/docs/types/classes/_u256_.u256.md @@ -24,7 +24,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U256.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/U256.ts#L14)* +*Defined in [U256.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/U256.ts#L14)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -186,7 +186,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1521,7 +1521,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1562,7 +1562,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1581,7 +1581,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1634,7 +1634,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1678,7 +1678,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1882,7 +1882,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_u32_.u32.html b/docs/types/classes/_u32_.u32.html index 9d18b612cd..d6a60cb026 100644 --- a/docs/types/classes/_u32_.u32.html +++ b/docs/types/classes/_u32_.u32.html @@ -1983,7 +1983,7 @@

constructor

⊕ new U32(value?: AnyNumber): U32

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -2006,7 +2006,7 @@

encodedLength

getencodedLength(): number

Inherited from AbstractInt.encodedLength

-

Defined in codec/AbstractInt.ts:56

+

Defined in codec/AbstractInt.ts:56

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2139,7 +2139,7 @@

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

-

Defined in codec/AbstractInt.ts:63

+

Defined in codec/AbstractInt.ts:63

description: Returns the number of bits in the value

Returns: UIntBitLength


@@ -3517,7 +3517,7 @@

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

-

Defined in codec/AbstractInt.ts:70

+

Defined in codec/AbstractInt.ts:70

description: Returns the BN representation of the number. (Compatibility)

Returns: BN


@@ -3554,7 +3554,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -3564,7 +3564,7 @@

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

-

Defined in codec/AbstractInt.ts:82

+

Defined in codec/AbstractInt.ts:82

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -3604,7 +3604,7 @@

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

-

Defined in codec/AbstractInt.ts:92

+

Defined in codec/AbstractInt.ts:92

description: Returns the string representation of the value

Parameters:

@@ -3653,7 +3653,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -3870,7 +3870,7 @@

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

-

Defined in codec/AbstractInt.ts:37

+

Defined in codec/AbstractInt.ts:37

Parameters:

@@ -4062,7 +4062,7 @@ diff --git a/docs/types/classes/_u32_.u32.md b/docs/types/classes/_u32_.u32.md index 5ff5d1e0a1..f0aac3d2cb 100644 --- a/docs/types/classes/_u32_.u32.md +++ b/docs/types/classes/_u32_.u32.md @@ -42,7 +42,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/U32.ts#L14)* **Parameters:** @@ -64,7 +64,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -204,7 +204,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1539,7 +1539,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1580,7 +1580,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1599,7 +1599,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1652,7 +1652,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1696,7 +1696,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1900,7 +1900,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_u64_.u64.html b/docs/types/classes/_u64_.u64.html index a87a82c547..ff06f84189 100644 --- a/docs/types/classes/_u64_.u64.html +++ b/docs/types/classes/_u64_.u64.html @@ -1977,7 +1977,7 @@

constructor

⊕ new U64(value?: AnyNumber): U64

Overrides UInt.constructor

-

Defined in U64.ts:14

+

Defined in U64.ts:14

Parameters:

@@ -2000,7 +2000,7 @@

encodedLength

getencodedLength(): number

Inherited from AbstractInt.encodedLength

-

Defined in codec/AbstractInt.ts:56

+

Defined in codec/AbstractInt.ts:56

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2133,7 +2133,7 @@

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

-

Defined in codec/AbstractInt.ts:63

+

Defined in codec/AbstractInt.ts:63

description: Returns the number of bits in the value

Returns: UIntBitLength


@@ -3511,7 +3511,7 @@

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

-

Defined in codec/AbstractInt.ts:70

+

Defined in codec/AbstractInt.ts:70

description: Returns the BN representation of the number. (Compatibility)

Returns: BN


@@ -3548,7 +3548,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -3558,7 +3558,7 @@

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

-

Defined in codec/AbstractInt.ts:82

+

Defined in codec/AbstractInt.ts:82

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -3598,7 +3598,7 @@

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

-

Defined in codec/AbstractInt.ts:92

+

Defined in codec/AbstractInt.ts:92

description: Returns the string representation of the value

Parameters:

@@ -3647,7 +3647,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -3864,7 +3864,7 @@

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

-

Defined in codec/AbstractInt.ts:37

+

Defined in codec/AbstractInt.ts:37

Parameters:

@@ -4056,7 +4056,7 @@ diff --git a/docs/types/classes/_u64_.u64.md b/docs/types/classes/_u64_.u64.md index 6ac875d938..2eef2a1153 100644 --- a/docs/types/classes/_u64_.u64.md +++ b/docs/types/classes/_u64_.u64.md @@ -30,7 +30,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/U64.ts#L14)* +*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/U64.ts#L14)* **Parameters:** @@ -52,7 +52,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -192,7 +192,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1527,7 +1527,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1568,7 +1568,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1587,7 +1587,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1640,7 +1640,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1684,7 +1684,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1888,7 +1888,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_u8_.u8.html b/docs/types/classes/_u8_.u8.html index b23d416e5e..49df4cffe6 100644 --- a/docs/types/classes/_u8_.u8.html +++ b/docs/types/classes/_u8_.u8.html @@ -1974,7 +1974,7 @@

constructor

⊕ new U8(value?: AnyNumber): U8

Overrides UInt.constructor

-

Defined in U8.ts:14

+

Defined in U8.ts:14

Parameters:

@@ -1997,7 +1997,7 @@

encodedLength

getencodedLength(): number

Inherited from AbstractInt.encodedLength

-

Defined in codec/AbstractInt.ts:56

+

Defined in codec/AbstractInt.ts:56

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2130,7 +2130,7 @@

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

-

Defined in codec/AbstractInt.ts:63

+

Defined in codec/AbstractInt.ts:63

description: Returns the number of bits in the value

Returns: UIntBitLength


@@ -3508,7 +3508,7 @@

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

-

Defined in codec/AbstractInt.ts:70

+

Defined in codec/AbstractInt.ts:70

description: Returns the BN representation of the number. (Compatibility)

Returns: BN


@@ -3545,7 +3545,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -3555,7 +3555,7 @@

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

-

Defined in codec/AbstractInt.ts:82

+

Defined in codec/AbstractInt.ts:82

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -3595,7 +3595,7 @@

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

-

Defined in codec/AbstractInt.ts:92

+

Defined in codec/AbstractInt.ts:92

description: Returns the string representation of the value

Parameters:

@@ -3644,7 +3644,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -3861,7 +3861,7 @@

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

-

Defined in codec/AbstractInt.ts:37

+

Defined in codec/AbstractInt.ts:37

Parameters:

@@ -4053,7 +4053,7 @@ diff --git a/docs/types/classes/_u8_.u8.md b/docs/types/classes/_u8_.u8.md index bf93924e86..fdc28742fc 100644 --- a/docs/types/classes/_u8_.u8.md +++ b/docs/types/classes/_u8_.u8.md @@ -24,7 +24,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U8.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/U8.ts#L14)* +*Defined in [U8.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/U8.ts#L14)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -186,7 +186,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1521,7 +1521,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1562,7 +1562,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1581,7 +1581,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1634,7 +1634,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1678,7 +1678,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1882,7 +1882,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_validatorprefs_.validatorprefs.html b/docs/types/classes/_validatorprefs_.validatorprefs.html index d9bfbf196b..376111c738 100644 --- a/docs/types/classes/_validatorprefs_.validatorprefs.html +++ b/docs/types/classes/_validatorprefs_.validatorprefs.html @@ -1979,7 +1979,7 @@

constructor

⊕ new ValidatorPrefs(value?: ValidatorPrefsValue | Uint8Array): ValidatorPrefs

Overrides Struct.constructor

-

Defined in ValidatorPrefs.ts:21

+

Defined in ValidatorPrefs.ts:21

Parameters:

@@ -2015,7 +2015,7 @@

Type

getType(): E

Inherited from Struct.Type

-

Defined in codec/Struct.ts:142

+

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


@@ -2023,21 +2023,21 @@

encodedLength

getencodedLength(): number

Inherited from Struct.encodedLength

-

Defined in codec/Struct.ts:149

+

Defined in codec/Struct.ts:149

description: The length of the value when encoded as a Uint8Array

Returns: number


unstakeThreshold

getunstakeThreshold(): U32

-

Defined in ValidatorPrefs.ts:32

+

Defined in ValidatorPrefs.ts:32

description: The unstake threshold as U32

Returns: U32


validatorPayment

getvalidatorPayment(): Balance

-

Defined in ValidatorPrefs.ts:39

+

Defined in ValidatorPrefs.ts:39

description: The payment config for the validator as Balance

Returns: Balance


@@ -2118,7 +2118,7 @@

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

-

Defined in codec/Struct.ts:159

+

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

@@ -2143,7 +2143,7 @@

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

-

Defined in codec/Struct.ts:166

+

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

@@ -2222,7 +2222,7 @@

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

-

Defined in codec/Struct.ts:173

+

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


@@ -2231,7 +2231,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

-

Defined in codec/Struct.ts:180

+

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string


@@ -2240,7 +2240,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

-

Defined in codec/Struct.ts:187

+

Defined in codec/Struct.ts:187

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2249,7 +2249,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

-

Defined in codec/Struct.ts:201

+

Defined in codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


@@ -2257,7 +2257,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

-

Defined in codec/Struct.ts:209

+

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2290,7 +2290,7 @@

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

-

Defined in codec/Struct.ts:122

+

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

@@ -2353,7 +2353,7 @@ diff --git a/docs/types/classes/_validatorprefs_.validatorprefs.md b/docs/types/classes/_validatorprefs_.validatorprefs.md index c937ba3668..c00de3288a 100644 --- a/docs/types/classes/_validatorprefs_.validatorprefs.md +++ b/docs/types/classes/_validatorprefs_.validatorprefs.md @@ -29,7 +29,7 @@ *Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* -*Defined in [ValidatorPrefs.ts:21](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/ValidatorPrefs.ts#L21)* +*Defined in [ValidatorPrefs.ts:21](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/ValidatorPrefs.ts#L21)* **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:142](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L142)* +*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L142)* *__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:149](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L149)* +*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L149)* *__description__*: The length of the value when encoded as a Uint8Array @@ -104,7 +104,7 @@ ___ getunstakeThreshold(): [U32](_u32_.u32.md) -*Defined in [ValidatorPrefs.ts:32](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/ValidatorPrefs.ts#L32)* +*Defined in [ValidatorPrefs.ts:32](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/ValidatorPrefs.ts#L32)* *__description__*: The unstake threshold as [U32](_u32_.u32.md) @@ -117,7 +117,7 @@ ___ getvalidatorPayment(): [Balance](_balance_.balance.md) -*Defined in [ValidatorPrefs.ts:39](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/ValidatorPrefs.ts#L39)* +*Defined in [ValidatorPrefs.ts:39](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/ValidatorPrefs.ts#L39)* *__description__*: The payment config for the validator as [Balance](_balance_.balance.md) @@ -219,7 +219,7 @@ ___ *Overrides Map.get* -*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L159)* +*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L159)* *__description__*: Returns a specific names entry in the structure @@ -240,7 +240,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* -*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L166)* +*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L166)* *__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) @@ -315,7 +315,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* -*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L173)* +*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L173)* *__description__*: Converts the Object to an standard JavaScript Array @@ -332,7 +332,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* -*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L180)* +*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L180)* *__description__*: Returns a hex string representation of the value @@ -349,7 +349,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* -*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L187)* +*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L187)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -366,7 +366,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* -*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L201)* +*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L201)* *__description__*: Returns the string representation of the value @@ -381,7 +381,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* -*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L209)* +*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L209)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -417,7 +417,7 @@ ___ *Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* -*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Struct.ts#L122)* +*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Struct.ts#L122)* **Type parameters:** diff --git a/docs/types/classes/_vote_.vote.md b/docs/types/classes/_vote_.vote.md index 15d6dbd2bf..c5b4ad9541 100644 --- a/docs/types/classes/_vote_.vote.md +++ b/docs/types/classes/_vote_.vote.md @@ -26,7 +26,7 @@ *Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* -*Defined in [I8.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/I8.ts#L14)* +*Defined in [I8.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/I8.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -188,7 +188,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1523,7 +1523,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1564,7 +1564,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Int.ts#L36)* +*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Int.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1583,7 +1583,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1636,7 +1636,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1680,7 +1680,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Int.ts#L48)* +*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Int.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1884,7 +1884,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_voteindex_.voteindex.html b/docs/types/classes/_voteindex_.voteindex.html index c788045f34..668ad135f6 100644 --- a/docs/types/classes/_voteindex_.voteindex.html +++ b/docs/types/classes/_voteindex_.voteindex.html @@ -1975,7 +1975,7 @@

⊕ new VoteIndex(value?: AnyNumber): VoteIndex

Inherited from U32.constructor

Overrides UInt.constructor

-

Defined in U32.ts:14

+

Defined in U32.ts:14

Parameters:

@@ -1998,7 +1998,7 @@

encodedLength

getencodedLength(): number

Inherited from AbstractInt.encodedLength

-

Defined in codec/AbstractInt.ts:56

+

Defined in codec/AbstractInt.ts:56

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2131,7 +2131,7 @@

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

-

Defined in codec/AbstractInt.ts:63

+

Defined in codec/AbstractInt.ts:63

description: Returns the number of bits in the value

Returns: UIntBitLength


@@ -3509,7 +3509,7 @@

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

-

Defined in codec/AbstractInt.ts:70

+

Defined in codec/AbstractInt.ts:70

description: Returns the BN representation of the number. (Compatibility)

Returns: BN


@@ -3546,7 +3546,7 @@

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

-

Defined in codec/UInt.ts:36

+

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string


@@ -3556,7 +3556,7 @@

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

-

Defined in codec/AbstractInt.ts:82

+

Defined in codec/AbstractInt.ts:82

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -3596,7 +3596,7 @@

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

-

Defined in codec/AbstractInt.ts:92

+

Defined in codec/AbstractInt.ts:92

description: Returns the string representation of the value

Parameters:

@@ -3645,7 +3645,7 @@

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

-

Defined in codec/UInt.ts:48

+

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -3862,7 +3862,7 @@

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

-

Defined in codec/AbstractInt.ts:37

+

Defined in codec/AbstractInt.ts:37

Parameters:

@@ -4054,7 +4054,7 @@ diff --git a/docs/types/classes/_voteindex_.voteindex.md b/docs/types/classes/_voteindex_.voteindex.md index 965fd0f074..a61da6343c 100644 --- a/docs/types/classes/_voteindex_.voteindex.md +++ b/docs/types/classes/_voteindex_.voteindex.md @@ -26,7 +26,7 @@ *Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* -*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/U32.ts#L14)* +*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/U32.ts#L14)* **Parameters:** @@ -48,7 +48,7 @@ getencodedLength(): `number` *Inherited from AbstractInt.encodedLength* -*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L56)* +*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L56)* *__description__*: The length of the value when encoded as a Uint8Array @@ -188,7 +188,7 @@ ___ *Overrides BN.bitLength* -*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L63)* +*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L63)* *__description__*: Returns the number of bits in the value @@ -1523,7 +1523,7 @@ ___ *Inherited from AbstractInt.toBn* -*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L70)* +*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L70)* *__description__*: Returns the BN representation of the number. (Compatibility) @@ -1564,7 +1564,7 @@ ___ *Overrides AbstractInt.toHex* -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L36)* +*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L36)* *__description__*: Returns a hex string representation of the value @@ -1583,7 +1583,7 @@ ___ *Overrides BN.toJSON* -*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L82)* +*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L82)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -1636,7 +1636,7 @@ ___ *Overrides BN.toString* -*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L92)* +*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L92)* *__description__*: Returns the string representation of the value @@ -1680,7 +1680,7 @@ ___ *Overrides AbstractInt.toU8a* -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/UInt.ts#L48)* +*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/UInt.ts#L48)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -1884,7 +1884,7 @@ ___ *Inherited from AbstractInt.decodeAbstracInt* -*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L37)* +*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L37)* **Parameters:** diff --git a/docs/types/classes/_votethreshold_.votethreshold.html b/docs/types/classes/_votethreshold_.votethreshold.html index f9b20b8486..0857fc0c23 100644 --- a/docs/types/classes/_votethreshold_.votethreshold.html +++ b/docs/types/classes/_votethreshold_.votethreshold.html @@ -1972,7 +1972,7 @@

constructor

⊕ new VoteThreshold(index?: number | Uint8Array): VoteThreshold

Overrides Enum.constructor

-

Defined in VoteThreshold.ts:12

+

Defined in VoteThreshold.ts:12

Parameters:

@@ -1995,7 +1995,7 @@

encodedLength

getencodedLength(): number

Inherited from Enum.encodedLength

-

Defined in codec/Enum.ts:64

+

Defined in codec/Enum.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number


@@ -2005,7 +2005,7 @@

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Enum.toHex

-

Defined in codec/Enum.ts:71

+

Defined in codec/Enum.ts:71

description: Returns a hex string representation of the value

Returns: string


@@ -2014,7 +2014,7 @@

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Enum.toJSON

-

Defined in codec/Enum.ts:78

+

Defined in codec/Enum.ts:78

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


@@ -2022,7 +2022,7 @@

toNumber

▸ toNumber(): number

Inherited from Enum.toNumber

-

Defined in codec/Enum.ts:85

+

Defined in codec/Enum.ts:85

description: Returns the number representation for the value

Returns: number


@@ -2031,7 +2031,7 @@

▸ toString(): string

Implementation of Codec.toString

Inherited from Enum.toString

-

Defined in codec/Enum.ts:92

+

Defined in codec/Enum.ts:92

description: Returns the string representation of the value

Returns: string


@@ -2039,7 +2039,7 @@

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Enum.toU8a

-

Defined in codec/Enum.ts:100

+

Defined in codec/Enum.ts:100

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

@@ -2064,7 +2064,7 @@

<Static> decodeEnum

▸ decodeEnum(def: EnumDef, value: Enum | Uint8Array | string | number): number | undefined

Inherited from Enum.decodeEnum

-

Defined in codec/Enum.ts:47

+

Defined in codec/Enum.ts:47

Parameters:

@@ -2125,7 +2125,7 @@ diff --git a/docs/types/classes/_votethreshold_.votethreshold.md b/docs/types/classes/_votethreshold_.votethreshold.md index dddcfda344..5968609db9 100644 --- a/docs/types/classes/_votethreshold_.votethreshold.md +++ b/docs/types/classes/_votethreshold_.votethreshold.md @@ -24,7 +24,7 @@ *Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* -*Defined in [VoteThreshold.ts:12](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/VoteThreshold.ts#L12)* +*Defined in [VoteThreshold.ts:12](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/VoteThreshold.ts#L12)* **Parameters:** @@ -46,7 +46,7 @@ getencodedLength(): `number` *Inherited from [Enum](_codec_enum_.enum.md).[encodedLength](_codec_enum_.enum.md#encodedlength)* -*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L64)* +*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L64)* *__description__*: The length of the value when encoded as a Uint8Array @@ -66,7 +66,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toHex](_codec_enum_.enum.md#tohex)* -*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L71)* +*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L71)* *__description__*: Returns a hex string representation of the value @@ -83,7 +83,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toJSON](_codec_enum_.enum.md#tojson)* -*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L78)* +*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L78)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -98,7 +98,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* -*Defined in [codec/Enum.ts:85](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L85)* +*Defined in [codec/Enum.ts:85](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L85)* *__description__*: Returns the number representation for the value @@ -115,7 +115,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toString](_codec_enum_.enum.md#tostring)* -*Defined in [codec/Enum.ts:92](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L92)* +*Defined in [codec/Enum.ts:92](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L92)* *__description__*: Returns the string representation of the value @@ -130,7 +130,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[toU8a](_codec_enum_.enum.md#tou8a)* -*Defined in [codec/Enum.ts:100](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L100)* +*Defined in [codec/Enum.ts:100](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/Enum.ts#L100)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications @@ -151,7 +151,7 @@ ___ *Inherited from [Enum](_codec_enum_.enum.md).[decodeEnum](_codec_enum_.enum.md#decodeenum)* -*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/Enum.ts#L47)* +*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/e802b8e/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 7e2841defc..ad6040c38c 100644 --- a/docs/types/enums/_codec_createtype_.typedefinfo.md +++ b/docs/types/enums/_codec_createtype_.typedefinfo.md @@ -21,7 +21,7 @@ **Compact**: -*Defined in [codec/createType.ts:18](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/createType.ts#L18)* +*Defined in [codec/createType.ts:18](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/createType.ts#L18)* ___ @@ -30,7 +30,7 @@ ___ **Option**: -*Defined in [codec/createType.ts:19](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/createType.ts#L19)* +*Defined in [codec/createType.ts:19](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/createType.ts#L19)* ___ @@ -39,7 +39,7 @@ ___ **Plain**: -*Defined in [codec/createType.ts:20](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/createType.ts#L20)* +*Defined in [codec/createType.ts:20](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/createType.ts#L20)* ___ @@ -48,7 +48,7 @@ ___ **Struct**: -*Defined in [codec/createType.ts:21](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/createType.ts#L21)* +*Defined in [codec/createType.ts:21](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/createType.ts#L21)* ___ @@ -57,7 +57,7 @@ ___ **Tuple**: -*Defined in [codec/createType.ts:22](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/createType.ts#L22)* +*Defined in [codec/createType.ts:22](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/createType.ts#L22)* ___ @@ -66,7 +66,7 @@ ___ **Vector**: -*Defined in [codec/createType.ts:23](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/createType.ts#L23)* +*Defined in [codec/createType.ts:23](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/createType.ts#L23)* ___ diff --git a/docs/types/index.html b/docs/types/index.html index 2026b6fd69..572e7d44d3 100644 --- a/docs/types/index.html +++ b/docs/types/index.html @@ -2009,7 +2009,7 @@ diff --git a/docs/types/interfaces/_method_.methodfunction.md b/docs/types/interfaces/_method_.methodfunction.md index ee2733847d..53f96754cb 100644 --- a/docs/types/interfaces/_method_.methodfunction.md +++ b/docs/types/interfaces/_method_.methodfunction.md @@ -7,7 +7,7 @@ # Callable ▸ **__call**(...args: *`any`[]*): [Method](../classes/_method_.method.md) -*Defined in [Method.ts:28](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L28)* +*Defined in [Method.ts:28](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L28)* **Parameters:** @@ -25,7 +25,7 @@ **● callIndex**: *`Uint8Array`* -*Defined in [Method.ts:30](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L30)* +*Defined in [Method.ts:30](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L30)* ___ @@ -34,7 +34,7 @@ ___ **● meta**: *[FunctionMetadata](../classes/_metadata_modules_.functionmetadata.md)* -*Defined in [Method.ts:31](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L31)* +*Defined in [Method.ts:31](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L31)* ___ @@ -43,7 +43,7 @@ ___ **● method**: *`string`* -*Defined in [Method.ts:32](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L32)* +*Defined in [Method.ts:32](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L32)* ___ @@ -52,7 +52,7 @@ ___ **● section**: *`string`* -*Defined in [Method.ts:33](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L33)* +*Defined in [Method.ts:33](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L33)* ___ @@ -61,7 +61,7 @@ ___ **● toJSON**: *`function`* -*Defined in [Method.ts:34](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Method.ts#L34)* +*Defined in [Method.ts:34](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Method.ts#L34)* #### Type declaration ▸(): `any` diff --git a/docs/types/interfaces/_storagekey_.storagefunction.md b/docs/types/interfaces/_storagekey_.storagefunction.md index 1e2b0390cf..ce559912dd 100644 --- a/docs/types/interfaces/_storagekey_.storagefunction.md +++ b/docs/types/interfaces/_storagekey_.storagefunction.md @@ -7,7 +7,7 @@ # Callable ▸ **__call**(arg?: *`any`*): `Uint8Array` -*Defined in [StorageKey.ts:12](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StorageKey.ts#L12)* +*Defined in [StorageKey.ts:12](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StorageKey.ts#L12)* **Parameters:** @@ -25,7 +25,7 @@ **● meta**: *[StorageFunctionMetadata](../classes/_metadata_modules_.storagefunctionmetadata.md)* -*Defined in [StorageKey.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StorageKey.ts#L14)* +*Defined in [StorageKey.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StorageKey.ts#L14)* ___ @@ -34,7 +34,7 @@ ___ **● method**: *`string`* -*Defined in [StorageKey.ts:15](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StorageKey.ts#L15)* +*Defined in [StorageKey.ts:15](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StorageKey.ts#L15)* ___ @@ -43,7 +43,7 @@ ___ **● section**: *`string`* -*Defined in [StorageKey.ts:16](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StorageKey.ts#L16)* +*Defined in [StorageKey.ts:16](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StorageKey.ts#L16)* ___ @@ -52,7 +52,7 @@ ___ **● toJSON**: *`function`* -*Defined in [StorageKey.ts:17](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StorageKey.ts#L17)* +*Defined in [StorageKey.ts:17](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StorageKey.ts#L17)* #### Type declaration ▸(): `any` diff --git a/docs/types/interfaces/_types_.codec.md b/docs/types/interfaces/_types_.codec.md index 632673e421..c823e604a0 100644 --- a/docs/types/interfaces/_types_.codec.md +++ b/docs/types/interfaces/_types_.codec.md @@ -159,7 +159,7 @@ **● encodedLength**: *`number`* -*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/types.ts#L24)* *__description__*: The length of the value when encoded as a Uint8Array @@ -173,7 +173,7 @@ ___ ▸ **toHex**(): `string` -*Defined in [types.ts:29](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/types.ts#L29)* +*Defined in [types.ts:29](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/types.ts#L29)* *__description__*: Returns a hex string representation of the value @@ -186,7 +186,7 @@ ___ ▸ **toJSON**(): `any` -*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/types.ts#L34)* +*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/types.ts#L34)* *__description__*: Converts the Object to JSON, typically used for RPC transfers @@ -199,7 +199,7 @@ ___ ▸ **toString**(): `string` -*Defined in [types.ts:39](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/types.ts#L39)* +*Defined in [types.ts:39](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/types.ts#L39)* *__description__*: Returns the string representation of the value @@ -212,7 +212,7 @@ ___ ▸ **toU8a**(isBare?: * `undefined` | `false` | `true`*, isStorageKey?: * `undefined` | `false` | `true`*): `Uint8Array` -*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/types.ts#L46)* +*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/types.ts#L46)* *__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications diff --git a/docs/types/modules/_accountindex_.md b/docs/types/modules/_accountindex_.md index 326d3645ae..06e6893769 100644 --- a/docs/types/modules/_accountindex_.md +++ b/docs/types/modules/_accountindex_.md @@ -20,7 +20,7 @@ **● ENUMSET_SIZE**: *`BN`* = new BN(64) -*Defined in [AccountIndex.ts:13](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/AccountIndex.ts#L13)* +*Defined in [AccountIndex.ts:13](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/AccountIndex.ts#L13)* ___ diff --git a/docs/types/modules/_address_.md b/docs/types/modules/_address_.md index acedc96678..995c6bdddd 100644 --- a/docs/types/modules/_address_.md +++ b/docs/types/modules/_address_.md @@ -20,7 +20,7 @@ **● ACCOUNT_ID_PREFIX**: *`Uint8Array`* = new Uint8Array([0xff]) -*Defined in [Address.ts:15](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Address.ts#L15)* +*Defined in [Address.ts:15](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Address.ts#L15)* ___ diff --git a/docs/types/modules/_bft_.md b/docs/types/modules/_bft_.md index 9c575fb369..b8fe7aa3dd 100644 --- a/docs/types/modules/_bft_.md +++ b/docs/types/modules/_bft_.md @@ -22,7 +22,7 @@ **Ƭ BftAuthoritySignatureValue**: *[[AnyU8a](_types_.md#anyu8a), [AnyU8a](_types_.md#anyu8a)]* -*Defined in [Bft.ts:12](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bft.ts#L12)* +*Defined in [Bft.ts:12](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bft.ts#L12)* ___ @@ -31,7 +31,7 @@ ___ **Ƭ BftHashSignatureValue**: *[[AnyU8a](_types_.md#anyu8a), [AnyU8a](_types_.md#anyu8a)]* -*Defined in [Bft.ts:43](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Bft.ts#L43)* +*Defined in [Bft.ts:43](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Bft.ts#L43)* ___ diff --git a/docs/types/modules/_block_.md b/docs/types/modules/_block_.md index 708cae1585..59a80a228e 100644 --- a/docs/types/modules/_block_.md +++ b/docs/types/modules/_block_.md @@ -20,7 +20,7 @@ **Ƭ BlockValue**: *`object`* -*Defined in [Block.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Block.ts#L14)* +*Defined in [Block.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Block.ts#L14)* #### Type declaration diff --git a/docs/types/modules/_classes_.md b/docs/types/modules/_classes_.md index ac242a885a..2d7c81c298 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/e79c6d8/packages/types/src/classes.ts#L7)* +*Defined in [classes.ts:7](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/classes.ts#L7)* ___ diff --git a/docs/types/modules/_codec_abstractint_.md b/docs/types/modules/_codec_abstractint_.md index de4fc48aad..8707ddd678 100644 --- a/docs/types/modules/_codec_abstractint_.md +++ b/docs/types/modules/_codec_abstractint_.md @@ -9,7 +9,7 @@ **Ƭ UIntBitLength**: * `8` | `16` | `32` | `64` | `128` | `256` * -*Defined in [codec/AbstractInt.ts:10](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L10)* +*Defined in [codec/AbstractInt.ts:10](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L10)* ___ @@ -21,7 +21,7 @@ ___ **● DEFAULT_UINT_BITS**: *`64`* = 64 -*Defined in [codec/AbstractInt.ts:12](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/AbstractInt.ts#L12)* +*Defined in [codec/AbstractInt.ts:12](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/AbstractInt.ts#L12)* ___ diff --git a/docs/types/modules/_codec_createtype_.md b/docs/types/modules/_codec_createtype_.md index 8f36e2bcf1..a41bf80901 100644 --- a/docs/types/modules/_codec_createtype_.md +++ b/docs/types/modules/_codec_createtype_.md @@ -28,7 +28,7 @@ **Ƭ TypeDef**: *`object`* -*Defined in [codec/createType.ts:26](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/createType.ts#L26)* +*Defined in [codec/createType.ts:26](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/createType.ts#L26)* #### Type declaration @@ -42,7 +42,7 @@ ___ ▸ **createClass**(type: * [Text](../classes/_text_.text.md) | `string`*, value?: *`any`*): [Constructor](_types_.md#constructor) -*Defined in [codec/createType.ts:172](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/createType.ts#L172)* +*Defined in [codec/createType.ts:172](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/createType.ts#L172)* **Parameters:** @@ -60,7 +60,7 @@ ___ ▸ **createType**(type: * [Text](../classes/_text_.text.md) | `string`*, value?: *`any`*): [Codec](../interfaces/_types_.codec.md) -*Defined in [codec/createType.ts:178](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/createType.ts#L178)* +*Defined in [codec/createType.ts:178](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/createType.ts#L178)* **Parameters:** @@ -78,7 +78,7 @@ ___ ▸ **getTypeClass**(value: *[TypeDef](_codec_createtype_.md#typedef)*): [Constructor](_types_.md#constructor) -*Defined in [codec/createType.ts:126](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/createType.ts#L126)* +*Defined in [codec/createType.ts:126](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/createType.ts#L126)* **Parameters:** @@ -95,7 +95,7 @@ ___ ▸ **getTypeDef**(_type: * [Text](../classes/_text_.text.md) | `string`*, name?: * `undefined` | `string`*): [TypeDef](_codec_createtype_.md#typedef) -*Defined in [codec/createType.ts:82](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/createType.ts#L82)* +*Defined in [codec/createType.ts:82](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/createType.ts#L82)* **Parameters:** @@ -113,7 +113,7 @@ ___ ▸ **typeSplit**(type: *`string`*): `Array`<`string`> -*Defined in [codec/createType.ts:34](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/createType.ts#L34)* +*Defined in [codec/createType.ts:34](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/createType.ts#L34)* **Parameters:** diff --git a/docs/types/modules/_codec_utils_decodeu8a_.md b/docs/types/modules/_codec_utils_decodeu8a_.md index ea11cc151c..4f848bc52d 100644 --- a/docs/types/modules/_codec_utils_decodeu8a_.md +++ b/docs/types/modules/_codec_utils_decodeu8a_.md @@ -8,7 +8,7 @@ ▸ **decodeU8a**(u8a: *`Uint8Array`*, types: *[Constructor](_types_.md#constructor)[]*): [Codec](../interfaces/_types_.codec.md)[] -*Defined in [codec/utils/decodeU8a.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/codec/utils/decodeU8a.ts#L14)* +*Defined in [codec/utils/decodeU8a.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/codec/utils/decodeU8a.ts#L14)* Given an u8a, and an array of Type constructors, decode the u8a against the types, and return an array of decoded values. diff --git a/docs/types/modules/_extrinsicsignature_.md b/docs/types/modules/_extrinsicsignature_.md index 91691f629d..b6a1011185 100644 --- a/docs/types/modules/_extrinsicsignature_.md +++ b/docs/types/modules/_extrinsicsignature_.md @@ -20,7 +20,7 @@ **● IMMORTAL_ERA**: *`Uint8Array`* = new Uint8Array([0]) -*Defined in [ExtrinsicSignature.ts:25](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/ExtrinsicSignature.ts#L25)* +*Defined in [ExtrinsicSignature.ts:25](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/ExtrinsicSignature.ts#L25)* ___ diff --git a/docs/types/modules/_header_.md b/docs/types/modules/_header_.md index 67e1468f39..d68b514dd8 100644 --- a/docs/types/modules/_header_.md +++ b/docs/types/modules/_header_.md @@ -20,7 +20,7 @@ **Ƭ HeaderValue**: *`object`* -*Defined in [Header.ts:16](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Header.ts#L16)* +*Defined in [Header.ts:16](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Header.ts#L16)* #### Type declaration diff --git a/docs/types/modules/_justification_.md b/docs/types/modules/_justification_.md index 309207377e..a7e0533f83 100644 --- a/docs/types/modules/_justification_.md +++ b/docs/types/modules/_justification_.md @@ -21,7 +21,7 @@ **Ƭ RhdJustificationValue**: *`object`* -*Defined in [Justification.ts:14](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/Justification.ts#L14)* +*Defined in [Justification.ts:14](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/Justification.ts#L14)* #### Type declaration diff --git a/docs/types/modules/_keyvalue_.md b/docs/types/modules/_keyvalue_.md index 88da7f98b0..cbca85b642 100644 --- a/docs/types/modules/_keyvalue_.md +++ b/docs/types/modules/_keyvalue_.md @@ -21,7 +21,7 @@ **Ƭ KeyValueOptionValue**: *[[AnyU8a](_types_.md#anyu8a), `undefined` | `string` | `Uint8Array` | `number`[]]* -*Defined in [KeyValue.ts:49](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/KeyValue.ts#L49)* +*Defined in [KeyValue.ts:49](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/KeyValue.ts#L49)* ___ diff --git a/docs/types/modules/_storedpendingchange_.md b/docs/types/modules/_storedpendingchange_.md index 2e36bb479d..defd0fb1ac 100644 --- a/docs/types/modules/_storedpendingchange_.md +++ b/docs/types/modules/_storedpendingchange_.md @@ -22,7 +22,7 @@ **Ƭ NextAuthorityValue**: *`object`* -*Defined in [StoredPendingChange.ts:15](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StoredPendingChange.ts#L15)* +*Defined in [StoredPendingChange.ts:15](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StoredPendingChange.ts#L15)* #### Type declaration @@ -33,7 +33,7 @@ ___ **Ƭ StoredPendingChangeValue**: *`object`* -*Defined in [StoredPendingChange.ts:20](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/StoredPendingChange.ts#L20)* +*Defined in [StoredPendingChange.ts:20](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/StoredPendingChange.ts#L20)* #### Type declaration diff --git a/docs/types/modules/_types_.md b/docs/types/modules/_types_.md index 00e7df9038..58135db53d 100644 --- a/docs/types/modules/_types_.md +++ b/docs/types/modules/_types_.md @@ -27,7 +27,7 @@ **Ƭ AnyNumber**: * `BN` | `Uint8Array` | `number` | `string` * -*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/types.ts#L7)* ___ @@ -37,7 +37,7 @@ ___ **Ƭ AnyString**: * `string` | `String` * -*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/types.ts#L9)* ___ @@ -47,7 +47,7 @@ ___ **Ƭ AnyU8a**: * `Uint8Array` | `Array`<`number`> | `string` * -*Defined in [types.ts:11](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/types.ts#L11)* +*Defined in [types.ts:11](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/types.ts#L11)* ___ @@ -57,7 +57,7 @@ ___ **Ƭ CodecTo**: * "toHex" | "toJSON" | "toString" | "toU8a" * -*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/types.ts#L49)* +*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/types.ts#L49)* ___ @@ -66,7 +66,7 @@ ___ **Ƭ Constructor**: *`object`* -*Defined in [types.ts:51](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/types.ts#L51)* +*Defined in [types.ts:51](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/types.ts#L51)* #### Type declaration @@ -77,7 +77,7 @@ ___ **Ƭ ConstructorDef**: *`object`* -*Defined in [types.ts:53](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/types.ts#L53)* +*Defined in [types.ts:53](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/types.ts#L53)* #### Type declaration @@ -90,7 +90,7 @@ ___ **Ƭ TypeDef**: *`object`* -*Defined in [types.ts:55](https://github.com/polkadot-js/api/blob/e79c6d8/packages/types/src/types.ts#L55)* +*Defined in [types.ts:55](https://github.com/polkadot-js/api/blob/e802b8e/packages/types/src/types.ts#L55)* #### Type declaration diff --git a/lerna.json b/lerna.json index 23fae0b1a6..2795cc4434 100644 --- a/lerna.json +++ b/lerna.json @@ -9,5 +9,5 @@ "packages": [ "packages/*" ], - "version": "0.35.18" + "version": "0.35.19" } diff --git a/package.json b/package.json index e8d78203ca..f0c1debccb 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "version": "0.35.18", + "version": "0.35.19", "private": true, "engines": { "node": "^10.13.0", diff --git a/packages/api-observable/package.json b/packages/api-observable/package.json index c5e6a59d4e..132521d892 100644 --- a/packages/api-observable/package.json +++ b/packages/api-observable/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/api-observable", - "version": "0.35.18", + "version": "0.35.19", "description": "An Observable wrapper around the Polkadot JS API", "main": "index.js", "keywords": [ @@ -30,10 +30,10 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-rx#readme", "dependencies": { "@babel/runtime": "^7.2.0", - "@polkadot/extrinsics": "^0.35.18", - "@polkadot/rpc-core": "^0.35.18", - "@polkadot/rpc-provider": "^0.35.18", - "@polkadot/storage": "^0.35.18", + "@polkadot/extrinsics": "^0.35.19", + "@polkadot/rpc-core": "^0.35.19", + "@polkadot/rpc-provider": "^0.35.19", + "@polkadot/storage": "^0.35.19", "@types/rx": "^4.1.1", "rxjs": "^6.3.3" } diff --git a/packages/api/package.json b/packages/api/package.json index dbf0f30bef..6877fca627 100644 --- a/packages/api/package.json +++ b/packages/api/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/api", - "version": "0.35.18", + "version": "0.35.19", "description": "An RxJS wrapper around the Polkadot JS RPC", "main": "index.js", "keywords": [ @@ -30,11 +30,11 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api#readme", "dependencies": { "@babel/runtime": "^7.2.0", - "@polkadot/extrinsics": "^0.35.18", - "@polkadot/rpc-provider": "^0.35.18", - "@polkadot/rpc-rx": "^0.35.18", - "@polkadot/storage": "^0.35.18", - "@polkadot/types": "^0.35.18", + "@polkadot/extrinsics": "^0.35.19", + "@polkadot/rpc-provider": "^0.35.19", + "@polkadot/rpc-rx": "^0.35.19", + "@polkadot/storage": "^0.35.19", + "@polkadot/types": "^0.35.19", "@types/rx": "^4.1.1", "rxjs": "^6.3.3" } diff --git a/packages/rpc-core/package.json b/packages/rpc-core/package.json index bc342daafd..0e0ab82798 100644 --- a/packages/rpc-core/package.json +++ b/packages/rpc-core/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-core", - "version": "0.35.18", + "version": "0.35.19", "description": "A JavaScript wrapper for the Polkadot JsonRPC interface", "main": "index.js", "keywords": [ @@ -30,9 +30,9 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-core#readme", "dependencies": { "@babel/runtime": "^7.2.0", - "@polkadot/jsonrpc": "^0.35.18", - "@polkadot/rpc-provider": "^0.35.18", - "@polkadot/types": "^0.35.18", + "@polkadot/jsonrpc": "^0.35.19", + "@polkadot/rpc-provider": "^0.35.19", + "@polkadot/types": "^0.35.19", "@polkadot/util": "^0.33.27" } } diff --git a/packages/rpc-provider/package.json b/packages/rpc-provider/package.json index 89e3112354..7c22eb7cbe 100644 --- a/packages/rpc-provider/package.json +++ b/packages/rpc-provider/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-provider", - "version": "0.35.18", + "version": "0.35.19", "description": "Transport providers for the API", "main": "index.js", "keywords": [ @@ -31,7 +31,7 @@ "dependencies": { "@babel/runtime": "^7.2.0", "@polkadot/keyring": "^0.33.27", - "@polkadot/storage": "^0.35.18", + "@polkadot/storage": "^0.35.19", "@polkadot/util": "^0.33.27", "@polkadot/util-crypto": "^0.33.27", "@types/nock": "^9.3.0", diff --git a/packages/rpc-rx/package.json b/packages/rpc-rx/package.json index 134e785df3..6e296c6828 100644 --- a/packages/rpc-rx/package.json +++ b/packages/rpc-rx/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-rx", - "version": "0.35.18", + "version": "0.35.19", "description": "An RxJs wrapper around the Polkadot JS API", "main": "index.js", "keywords": [ @@ -30,8 +30,8 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-rx#readme", "dependencies": { "@babel/runtime": "^7.2.0", - "@polkadot/rpc-core": "^0.35.18", - "@polkadot/rpc-provider": "^0.35.18", + "@polkadot/rpc-core": "^0.35.19", + "@polkadot/rpc-provider": "^0.35.19", "@types/rx": "^4.1.1", "rxjs": "^6.3.3" } diff --git a/packages/type-extrinsics/package.json b/packages/type-extrinsics/package.json index 0ddc32f286..c689eea97c 100644 --- a/packages/type-extrinsics/package.json +++ b/packages/type-extrinsics/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/extrinsics", - "version": "0.35.18", + "version": "0.35.19", "main": "index.js", "repository": "https://github.com/polkadot-js/api.git", "author": "Jaco Greeff ", @@ -11,7 +11,7 @@ "license": "Apache-2.0", "dependencies": { "@babel/runtime": "^7.2.0", - "@polkadot/types": "^0.35.18", + "@polkadot/types": "^0.35.19", "@polkadot/util": "^0.33.27" } } diff --git a/packages/type-jsonrpc/package.json b/packages/type-jsonrpc/package.json index c793b0f94c..ae7d126407 100644 --- a/packages/type-jsonrpc/package.json +++ b/packages/type-jsonrpc/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/jsonrpc", - "version": "0.35.18", + "version": "0.35.19", "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 72f259d913..369cc90bba 100644 --- a/packages/type-storage/package.json +++ b/packages/type-storage/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/storage", - "version": "0.35.18", + "version": "0.35.19", "description": "Generic wrapper wrapper around state storage", "main": "index.js", "engines": { @@ -31,7 +31,7 @@ "dependencies": { "@babel/runtime": "^7.2.0", "@polkadot/keyring": "^0.33.27", - "@polkadot/types": "^0.35.18", + "@polkadot/types": "^0.35.19", "@polkadot/util": "^0.33.27", "@polkadot/util-crypto": "^0.33.27" } diff --git a/packages/types/package.json b/packages/types/package.json index c41da47a27..2f8a8a483d 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/types", - "version": "0.35.18", + "version": "0.35.19", "description": "Implementation of the Parity codec", "main": "index.js", "keywords": [