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

[CI Skip] 0.30.10

Browse Source
This commit is contained in:
Travis CI
2018-10-02 09:34:37 +00:00
parent 48e57f9a55
commit e4805c2b8d
212 changed files with 25280 additions and 383 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/GLOSSARY.html
+1 -1
View File
@@ -402,7 +402,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"GLOSSARY.md","mtime":"2018-10-02T09:11:18.875Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:13:59.444Z"},"basePath":".","book":{"language":""}});
gitbook.page.hasChanged({"page":{"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"GLOSSARY.md","mtime":"2018-10-02T09:31:33.332Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:34:30.873Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
docs/api-observable/classes/_base_.apibase.md
+7 -7
View File
@@ -14,7 +14,7 @@
⊕ **new ApiBase**(api: *`RxApiInterface`*): [ApiBase](_base_.apibase.md)
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L22)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L22)*
**Parameters:**
@@ -34,7 +34,7 @@ ___
**● api**: *`RxApiInterface`*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L22)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L22)*
___
@@ -46,7 +46,7 @@ ___
▸ **combine**<`T`,`R`>(observables: *`Array`<`Observable`<`any`>>*, mapfn?: *`MapFn`<`R`, `T`>*): `Observable`<`T`>
*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L28)*
*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L28)*
**Type parameters:**
@@ -68,7 +68,7 @@ ___
▸ **isConnected**(): `Observable`<`boolean`>
*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L36)*
*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L36)*
**Returns:** `Observable`<`boolean`>
@@ -79,7 +79,7 @@ ___
▸ **rawCall**<`T`>(__namedParameters: *`object`*, ...params: *`Array`<`any`>*): `Observable`<`T`>
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L40)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L40)*
**Type parameters:**
@@ -100,7 +100,7 @@ ___
▸ **rawStorage**<`T`>(key: *`StorageFunction`*, ...params: *`Array`<`any`>*): `Observable`<`T`>
*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L52)*
*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L52)*
**Type parameters:**
@@ -121,7 +121,7 @@ ___
▸ **rawStorageMulti**<`T`>(...keys: *`Array`< [`StorageFunction`] &#124; [`StorageFunction`, `any`]>*): `Observable`<`T`>
*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L63)*
*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L63)*
**Type parameters:**
docs/api-observable/classes/_calls_.apicalls.md
+38 -38
View File
@@ -18,7 +18,7 @@
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L22)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L22)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[api](_base_.apibase.md#api)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L22)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L22)*
___
@@ -52,7 +52,7 @@ ___
▸ **bestNumber**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Calls.ts#L13)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Calls.ts#L13)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -63,7 +63,7 @@ ___
▸ **chainGetBlock**(hash: *`Uint8Array`*): `Observable`< `SignedBlock` &#124; `undefined`>
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Calls.ts#L25)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Calls.ts#L25)*
**Parameters:**
@@ -80,7 +80,7 @@ ___
▸ **chainNewHead**(): `Observable`< `Header` &#124; `undefined`>
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Calls.ts#L29)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Calls.ts#L29)*
**Returns:** `Observable`< `Header` &#124; `undefined`>
@@ -93,7 +93,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[combine](_base_.apibase.md#combine)*
*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L28)*
*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L28)*
**Type parameters:**
@@ -117,7 +117,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democacyVoteOf](_queries_.apiqueries.md#democacyvoteof)*
*Defined in [Queries.ts:76](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L76)*
*Defined in [Queries.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L76)*
**Parameters:**
@@ -137,7 +137,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democacyVotersFor](_queries_.apiqueries.md#democacyvotersfor)*
*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L80)*
*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L80)*
**Parameters:**
@@ -156,7 +156,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L19)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L19)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -169,7 +169,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L23)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L23)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -182,7 +182,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyProposalDeposits](_queries_.apiqueries.md#democracyproposaldeposits)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L27)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L27)*
**Parameters:**
@@ -201,7 +201,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyPublicProposals](_queries_.apiqueries.md#democracypublicproposals)*
*Defined in [Queries.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L40)*
*Defined in [Queries.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L40)*
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
@@ -214,7 +214,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyReferendumCount](_queries_.apiqueries.md#democracyreferendumcount)*
*Defined in [Queries.ts:59](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L59)*
*Defined in [Queries.ts:59](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L59)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -227,7 +227,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyReferendumInfoOf](_queries_.apiqueries.md#democracyreferenduminfoof)*
*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L63)*
*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L63)*
**Parameters:**
@@ -246,7 +246,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)*
*Defined in [Queries.ts:91](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L91)*
*Defined in [Queries.ts:91](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L91)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -259,7 +259,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)*
*Defined in [Queries.ts:116](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L116)*
*Defined in [Queries.ts:116](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L116)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -272,7 +272,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)*
*Defined in [Queries.ts:95](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L95)*
*Defined in [Queries.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L95)*
**Returns:** `Observable`<[RxFees](../modules/_types_d_.md#rxfees)>
@@ -285,7 +285,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L36)*
*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L36)*
**Returns:** `Observable`<`boolean`>
@@ -298,7 +298,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L40)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L40)*
**Type parameters:**
@@ -321,7 +321,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L52)*
*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L52)*
**Type parameters:**
@@ -344,7 +344,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L63)*
*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L63)*
**Type parameters:**
@@ -366,7 +366,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
*Defined in [Queries.ts:128](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L128)*
*Defined in [Queries.ts:128](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L128)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -379,7 +379,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
*Defined in [Queries.ts:132](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L132)*
*Defined in [Queries.ts:132](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L132)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -392,7 +392,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L136)*
*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L136)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -405,7 +405,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L140)*
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L140)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -418,7 +418,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
*Defined in [Queries.ts:120](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L120)*
*Defined in [Queries.ts:120](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L120)*
**Returns:** `Observable`< `Perbill` &#124; `undefined`>
@@ -431,7 +431,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
*Defined in [Queries.ts:124](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L124)*
*Defined in [Queries.ts:124](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L124)*
**Returns:** `Observable`< `Balance` &#124; `undefined`>
@@ -444,7 +444,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L148)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L148)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -457,7 +457,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L144)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L144)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -470,7 +470,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingFreeBalanceOf](_queries_.apiqueries.md#stakingfreebalanceof)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L171)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L171)*
**Parameters:**
@@ -489,7 +489,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L159)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L159)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -502,7 +502,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
*Defined in [Queries.ts:186](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L186)*
*Defined in [Queries.ts:186](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L186)*
**Parameters:**
@@ -521,7 +521,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L175)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L175)*
**Parameters:**
@@ -540,7 +540,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingReservedBalanceOf](_queries_.apiqueries.md#stakingreservedbalanceof)*
*Defined in [Queries.ts:191](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L191)*
*Defined in [Queries.ts:191](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L191)*
**Parameters:**
@@ -559,7 +559,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[systemAccountIndexOf](_queries_.apiqueries.md#systemaccountindexof)*
*Defined in [Queries.ts:203](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L203)*
*Defined in [Queries.ts:203](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L203)*
**Parameters:**
@@ -578,7 +578,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[timestampBlockPeriod](_queries_.apiqueries.md#timestampblockperiod)*
*Defined in [Queries.ts:195](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L195)*
*Defined in [Queries.ts:195](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L195)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -591,7 +591,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[timestampNow](_queries_.apiqueries.md#timestampnow)*
*Defined in [Queries.ts:199](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L199)*
*Defined in [Queries.ts:199](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L199)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -604,7 +604,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
*Defined in [Queries.ts:207](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L207)*
*Defined in [Queries.ts:207](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L207)*
**Returns:** `Observable`<`u32`>
docs/api-observable/classes/_classes_.rxproposal.md
+19 -19
View File
@@ -21,7 +21,7 @@
*Overrides Struct.__constructor*
*Defined in [classes.ts:9](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L9)*
*Defined in [classes.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L9)*
**Parameters:**
@@ -43,7 +43,7 @@ ___
*Inherited from Struct._Types*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L27)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
@@ -54,7 +54,7 @@ ___
*Inherited from Struct._jsonMap*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L26)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
@@ -65,7 +65,7 @@ ___
*Inherited from Base.raw*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Base.ts#L19)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
@@ -79,7 +79,7 @@ getType(): `E`
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L76)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
@@ -90,7 +90,7 @@ ___
getaddress(): `AccountId`
*Defined in [classes.ts:18](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L18)*
*Defined in [classes.ts:18](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L18)*
**Returns:** `AccountId`
@@ -101,7 +101,7 @@ ___
getid(): `PropIndex`
*Defined in [classes.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L22)*
*Defined in [classes.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L22)*
**Returns:** `PropIndex`
@@ -112,7 +112,7 @@ ___
getproposal(): `Proposal`
*Defined in [classes.ts:26](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L26)*
*Defined in [classes.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L26)*
**Returns:** `Proposal`
@@ -130,7 +130,7 @@ ___
*Overrides Base.byteLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L80)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
@@ -145,7 +145,7 @@ ___
*Overrides Base.fromJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L86)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)*
**Parameters:**
@@ -166,7 +166,7 @@ ___
*Overrides Base.fromU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L101)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
@@ -185,7 +185,7 @@ ___
*Inherited from Struct.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L111)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
@@ -204,7 +204,7 @@ ___
*Inherited from Struct.keys*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L126)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
@@ -219,7 +219,7 @@ ___
*Overrides Base.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L115)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)*
**Returns:** `any`
@@ -234,7 +234,7 @@ ___
*Overrides Base.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L138)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
@@ -249,7 +249,7 @@ ___
*Overrides Base.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L130)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
@@ -268,7 +268,7 @@ ___
*Inherited from Struct.values*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L147)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<`Base`>
@@ -281,7 +281,7 @@ ___
*Inherited from Struct.decode*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L45)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
@@ -307,7 +307,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L66)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)*
**Type parameters:**
docs/api-observable/classes/_classes_.rxproposaldeposits.md
+18 -18
View File
@@ -21,7 +21,7 @@
*Overrides Struct.__constructor*
*Defined in [classes.ts:31](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L31)*
*Defined in [classes.ts:31](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L31)*
**Parameters:**
@@ -43,7 +43,7 @@ ___
*Inherited from Struct._Types*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L27)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
@@ -54,7 +54,7 @@ ___
*Inherited from Struct._jsonMap*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L26)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
@@ -65,7 +65,7 @@ ___
*Inherited from Base.raw*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Base.ts#L19)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
@@ -79,7 +79,7 @@ getType(): `E`
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L76)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
@@ -90,7 +90,7 @@ ___
getaddresses(): `Vector`<`AccountId`>
*Defined in [classes.ts:39](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L39)*
*Defined in [classes.ts:39](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L39)*
**Returns:** `Vector`<`AccountId`>
@@ -101,7 +101,7 @@ ___
getbalance(): `Balance`
*Defined in [classes.ts:43](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L43)*
*Defined in [classes.ts:43](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L43)*
**Returns:** `Balance`
@@ -119,7 +119,7 @@ ___
*Overrides Base.byteLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L80)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
@@ -134,7 +134,7 @@ ___
*Overrides Base.fromJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L86)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)*
**Parameters:**
@@ -155,7 +155,7 @@ ___
*Overrides Base.fromU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L101)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
@@ -174,7 +174,7 @@ ___
*Inherited from Struct.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L111)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
@@ -193,7 +193,7 @@ ___
*Inherited from Struct.keys*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L126)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
@@ -208,7 +208,7 @@ ___
*Overrides Base.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L115)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)*
**Returns:** `any`
@@ -223,7 +223,7 @@ ___
*Overrides Base.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L138)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
@@ -238,7 +238,7 @@ ___
*Overrides Base.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L130)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
@@ -257,7 +257,7 @@ ___
*Inherited from Struct.values*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L147)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<`Base`>
@@ -270,7 +270,7 @@ ___
*Inherited from Struct.decode*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L45)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
@@ -296,7 +296,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L66)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)*
**Type parameters:**
docs/api-observable/classes/_classes_.rxreferendum.md
+20 -20
View File
@@ -21,7 +21,7 @@
*Overrides Struct.__constructor*
*Defined in [classes.ts:48](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L48)*
*Defined in [classes.ts:48](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L48)*
**Parameters:**
@@ -44,7 +44,7 @@ ___
*Inherited from Struct._Types*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L27)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
@@ -55,7 +55,7 @@ ___
*Inherited from Struct._jsonMap*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L26)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
@@ -66,7 +66,7 @@ ___
*Inherited from Base.raw*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Base.ts#L19)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
@@ -80,7 +80,7 @@ getType(): `E`
*Inherited from Struct.Type*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L76)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
@@ -91,7 +91,7 @@ ___
getblockNumber(): `BlockNumber`
*Defined in [classes.ts:58](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L58)*
*Defined in [classes.ts:58](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L58)*
**Returns:** `BlockNumber`
@@ -102,7 +102,7 @@ ___
getid(): `ReferendumIndex`
*Defined in [classes.ts:62](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L62)*
*Defined in [classes.ts:62](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L62)*
**Returns:** `ReferendumIndex`
@@ -113,7 +113,7 @@ ___
getproposal(): `Proposal`
*Defined in [classes.ts:66](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L66)*
*Defined in [classes.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L66)*
**Returns:** `Proposal`
@@ -124,7 +124,7 @@ ___
getvoteThreshold(): `VoteThreshold`
*Defined in [classes.ts:70](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/classes.ts#L70)*
*Defined in [classes.ts:70](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/classes.ts#L70)*
**Returns:** `VoteThreshold`
@@ -142,7 +142,7 @@ ___
*Overrides Base.byteLength*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L80)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
@@ -157,7 +157,7 @@ ___
*Overrides Base.fromJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L86)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)*
**Parameters:**
@@ -178,7 +178,7 @@ ___
*Overrides Base.fromU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L101)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
@@ -197,7 +197,7 @@ ___
*Inherited from Struct.get*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L111)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
@@ -216,7 +216,7 @@ ___
*Inherited from Struct.keys*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L126)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
@@ -231,7 +231,7 @@ ___
*Overrides Base.toJSON*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L115)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)*
**Returns:** `any`
@@ -246,7 +246,7 @@ ___
*Overrides Base.toString*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L138)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
@@ -261,7 +261,7 @@ ___
*Overrides Base.toU8a*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L130)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
@@ -280,7 +280,7 @@ ___
*Inherited from Struct.values*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L147)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<`Base`>
@@ -293,7 +293,7 @@ ___
*Inherited from Struct.decode*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L45)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
@@ -319,7 +319,7 @@ ___
*Inherited from Struct.with*
*Defined in [/home/travis/build/polkadot-js/api/packages/api-codec/src/codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-codec/src/codec/Struct.ts#L66)*
*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)*
**Type parameters:**
docs/api-observable/classes/_combined_.apicombined.md
+58 -58
View File
@@ -18,7 +18,7 @@
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L22)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L22)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[api](_base_.apibase.md#api)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L22)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L22)*
___
@@ -54,7 +54,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Calls.ts#L13)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Calls.ts#L13)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -67,7 +67,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[chainGetBlock](_calls_.apicalls.md#chaingetblock)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Calls.ts#L25)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Calls.ts#L25)*
**Parameters:**
@@ -86,7 +86,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[chainNewHead](_calls_.apicalls.md#chainnewhead)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Calls.ts#L29)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Calls.ts#L29)*
**Returns:** `Observable`< `Header` &#124; `undefined`>
@@ -99,7 +99,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[combine](_base_.apibase.md#combine)*
*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L28)*
*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L28)*
**Type parameters:**
@@ -123,7 +123,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democacyVoteOf](_queries_.apiqueries.md#democacyvoteof)*
*Defined in [Queries.ts:76](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L76)*
*Defined in [Queries.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L76)*
**Parameters:**
@@ -143,7 +143,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democacyVotersFor](_queries_.apiqueries.md#democacyvotersfor)*
*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L80)*
*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L80)*
**Parameters:**
@@ -162,7 +162,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L19)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L19)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -175,7 +175,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L23)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L23)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -186,7 +186,7 @@ ___
▸ **democracyProposalCount**(): `Observable`<`number`>
*Defined in [Combined.ts:20](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L20)*
*Defined in [Combined.ts:20](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L20)*
**Returns:** `Observable`<`number`>
@@ -199,7 +199,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyProposalDeposits](_queries_.apiqueries.md#democracyproposaldeposits)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L27)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L27)*
**Parameters:**
@@ -218,7 +218,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyPublicProposals](_queries_.apiqueries.md#democracypublicproposals)*
*Defined in [Queries.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L40)*
*Defined in [Queries.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L40)*
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
@@ -231,7 +231,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyReferendumCount](_queries_.apiqueries.md#democracyreferendumcount)*
*Defined in [Queries.ts:59](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L59)*
*Defined in [Queries.ts:59](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L59)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -244,7 +244,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyReferendumInfoOf](_queries_.apiqueries.md#democracyreferenduminfoof)*
*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L63)*
*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L63)*
**Parameters:**
@@ -261,7 +261,7 @@ ___
▸ **democracyReferendumInfos**(referendumIds: *`Array`< `ReferendumIndex` &#124; `BN` &#124; `number`>*): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
*Defined in [Combined.ts:30](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L30)*
*Defined in [Combined.ts:30](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L30)*
**Parameters:**
@@ -278,7 +278,7 @@ ___
▸ **democracyReferendumVoters**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<[RxReferendumVote](../modules/_types_d_.md#rxreferendumvote)>>
*Defined in [Combined.ts:42](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L42)*
*Defined in [Combined.ts:42](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L42)*
**Parameters:**
@@ -295,7 +295,7 @@ ___
▸ **democracyReferendums**(): `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
*Defined in [Combined.ts:58](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L58)*
*Defined in [Combined.ts:58](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L58)*
**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
@@ -306,7 +306,7 @@ ___
▸ **democracyVotersBalancesOf**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<`Balance`>>
*Defined in [Combined.ts:87](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L87)*
*Defined in [Combined.ts:87](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L87)*
**Parameters:**
@@ -323,7 +323,7 @@ ___
▸ **democracyVotersVotesOf**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<`Bool`>>
*Defined in [Combined.ts:103](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L103)*
*Defined in [Combined.ts:103](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L103)*
**Parameters:**
@@ -340,7 +340,7 @@ ___
▸ **democracyVotesOf**(index: * `ReferendumIndex` &#124; `BN` &#124; `number`*, addresses: *`Array`< `AccountId` &#124; `string`>*): `Observable`<`boolean`>
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L79)*
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L79)*
**Parameters:**
@@ -360,7 +360,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)*
*Defined in [Queries.ts:91](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L91)*
*Defined in [Queries.ts:91](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L91)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -371,7 +371,7 @@ ___
▸ **eraBlockLength**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:114](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L114)*
*Defined in [Combined.ts:114](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L114)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -382,7 +382,7 @@ ___
▸ **eraBlockProgress**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:129](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L129)*
*Defined in [Combined.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L129)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -393,7 +393,7 @@ ___
▸ **eraBlockRemaining**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:151](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L151)*
*Defined in [Combined.ts:151](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L151)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -406,7 +406,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)*
*Defined in [Queries.ts:116](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L116)*
*Defined in [Queries.ts:116](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L116)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -419,7 +419,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)*
*Defined in [Queries.ts:95](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L95)*
*Defined in [Queries.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L95)*
**Returns:** `Observable`<[RxFees](../modules/_types_d_.md#rxfees)>
@@ -432,7 +432,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L36)*
*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L36)*
**Returns:** `Observable`<`boolean`>
@@ -445,7 +445,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L40)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L40)*
**Type parameters:**
@@ -468,7 +468,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L52)*
*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L52)*
**Type parameters:**
@@ -491,7 +491,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L63)*
*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L63)*
**Type parameters:**
@@ -511,7 +511,7 @@ ___
▸ **sessionBlockProgress**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:166](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L166)*
*Defined in [Combined.ts:166](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L166)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -522,7 +522,7 @@ ___
▸ **sessionBlockRemaining**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Combined.ts:185](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L185)*
*Defined in [Combined.ts:185](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L185)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -533,7 +533,7 @@ ___
▸ **sessionBrokenValue**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Combined.ts:200](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L200)*
*Defined in [Combined.ts:200](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L200)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -546,7 +546,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
*Defined in [Queries.ts:128](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L128)*
*Defined in [Queries.ts:128](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L128)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -559,7 +559,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
*Defined in [Queries.ts:132](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L132)*
*Defined in [Queries.ts:132](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L132)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -572,7 +572,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L136)*
*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L136)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -585,7 +585,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L140)*
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L140)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -598,7 +598,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
*Defined in [Queries.ts:120](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L120)*
*Defined in [Queries.ts:120](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L120)*
**Returns:** `Observable`< `Perbill` &#124; `undefined`>
@@ -611,7 +611,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
*Defined in [Queries.ts:124](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L124)*
*Defined in [Queries.ts:124](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L124)*
**Returns:** `Observable`< `Balance` &#124; `undefined`>
@@ -622,7 +622,7 @@ ___
▸ **sessionTimeExpected**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Combined.ts:219](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L219)*
*Defined in [Combined.ts:219](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L219)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -633,7 +633,7 @@ ___
▸ **sessionTimeRemaining**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Combined.ts:234](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L234)*
*Defined in [Combined.ts:234](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L234)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -646,7 +646,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L148)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L148)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -659,7 +659,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L144)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L144)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -672,7 +672,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingFreeBalanceOf](_queries_.apiqueries.md#stakingfreebalanceof)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L171)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L171)*
**Parameters:**
@@ -691,7 +691,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L159)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L159)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -704,7 +704,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
*Defined in [Queries.ts:186](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L186)*
*Defined in [Queries.ts:186](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L186)*
**Parameters:**
@@ -723,7 +723,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L175)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L175)*
**Parameters:**
@@ -742,7 +742,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingReservedBalanceOf](_queries_.apiqueries.md#stakingreservedbalanceof)*
*Defined in [Queries.ts:191](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L191)*
*Defined in [Queries.ts:191](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L191)*
**Parameters:**
@@ -761,7 +761,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[systemAccountIndexOf](_queries_.apiqueries.md#systemaccountindexof)*
*Defined in [Queries.ts:203](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L203)*
*Defined in [Queries.ts:203](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L203)*
**Parameters:**
@@ -780,7 +780,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[timestampBlockPeriod](_queries_.apiqueries.md#timestampblockperiod)*
*Defined in [Queries.ts:195](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L195)*
*Defined in [Queries.ts:195](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L195)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -793,7 +793,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[timestampNow](_queries_.apiqueries.md#timestampnow)*
*Defined in [Queries.ts:199](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L199)*
*Defined in [Queries.ts:199](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L199)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -804,7 +804,7 @@ ___
▸ **validatingBalance**(address: * `AccountId` &#124; `string`*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)>
*Defined in [Combined.ts:249](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L249)*
*Defined in [Combined.ts:249](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L249)*
**Parameters:**
@@ -821,7 +821,7 @@ ___
▸ **validatingBalances**(...addresses: *`Array`< `AccountId` &#124; `string`>*): `Observable`<[RxBalanceMap](../modules/_types_d_.md#rxbalancemap)>
*Defined in [Combined.ts:274](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L274)*
*Defined in [Combined.ts:274](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L274)*
**Parameters:**
@@ -840,7 +840,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
*Defined in [Queries.ts:207](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L207)*
*Defined in [Queries.ts:207](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L207)*
**Returns:** `Observable`<`u32`>
@@ -851,7 +851,7 @@ ___
▸ **votingBalance**(_address: * `AccountId` &#124; `string`*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)>
*Defined in [Combined.ts:288](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L288)*
*Defined in [Combined.ts:288](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L288)*
**Parameters:**
@@ -868,7 +868,7 @@ ___
▸ **votingBalances**(...addresses: *`Array`< `AccountId` &#124; `string`>*): `Observable`<[RxBalance](../modules/_types_d_.md#rxbalance)[]>
*Defined in [Combined.ts:322](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L322)*
*Defined in [Combined.ts:322](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L322)*
**Parameters:**
@@ -885,7 +885,7 @@ ___
▸ **votingBalancesNominatorsFor**(address: * `AccountId` &#124; `string`*): `Observable`<`any`>
*Defined in [Combined.ts:311](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L311)*
*Defined in [Combined.ts:311](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L311)*
**Parameters:**
docs/api-observable/classes/_index_.api.md
+58 -58
View File
@@ -16,7 +16,7 @@
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L22)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L22)*
**Parameters:**
@@ -38,7 +38,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[api](_base_.apibase.md#api)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L22)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L22)*
___
@@ -52,7 +52,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[bestNumber](_calls_.apicalls.md#bestnumber)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Calls.ts#L13)*
*Defined in [Calls.ts:13](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Calls.ts#L13)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -65,7 +65,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[chainGetBlock](_calls_.apicalls.md#chaingetblock)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Calls.ts#L25)*
*Defined in [Calls.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Calls.ts#L25)*
**Parameters:**
@@ -84,7 +84,7 @@ ___
*Inherited from [ApiCalls](_calls_.apicalls.md).[chainNewHead](_calls_.apicalls.md#chainnewhead)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Calls.ts#L29)*
*Defined in [Calls.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Calls.ts#L29)*
**Returns:** `Observable`< `Header` &#124; `undefined`>
@@ -97,7 +97,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[combine](_base_.apibase.md#combine)*
*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L28)*
*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L28)*
**Type parameters:**
@@ -121,7 +121,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democacyVoteOf](_queries_.apiqueries.md#democacyvoteof)*
*Defined in [Queries.ts:76](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L76)*
*Defined in [Queries.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L76)*
**Parameters:**
@@ -141,7 +141,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democacyVotersFor](_queries_.apiqueries.md#democacyvotersfor)*
*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L80)*
*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L80)*
**Parameters:**
@@ -160,7 +160,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyLaunchPeriod](_queries_.apiqueries.md#democracylaunchperiod)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L19)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L19)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -173,7 +173,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyNextTally](_queries_.apiqueries.md#democracynexttally)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L23)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L23)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -186,7 +186,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyProposalCount](_combined_.apicombined.md#democracyproposalcount)*
*Defined in [Combined.ts:20](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L20)*
*Defined in [Combined.ts:20](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L20)*
**Returns:** `Observable`<`number`>
@@ -199,7 +199,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyProposalDeposits](_queries_.apiqueries.md#democracyproposaldeposits)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L27)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L27)*
**Parameters:**
@@ -218,7 +218,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyPublicProposals](_queries_.apiqueries.md#democracypublicproposals)*
*Defined in [Queries.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L40)*
*Defined in [Queries.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L40)*
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
@@ -231,7 +231,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyReferendumCount](_queries_.apiqueries.md#democracyreferendumcount)*
*Defined in [Queries.ts:59](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L59)*
*Defined in [Queries.ts:59](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L59)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -244,7 +244,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyReferendumInfoOf](_queries_.apiqueries.md#democracyreferenduminfoof)*
*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L63)*
*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L63)*
**Parameters:**
@@ -263,7 +263,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyReferendumInfos](_combined_.apicombined.md#democracyreferenduminfos)*
*Defined in [Combined.ts:30](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L30)*
*Defined in [Combined.ts:30](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L30)*
**Parameters:**
@@ -282,7 +282,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyReferendumVoters](_combined_.apicombined.md#democracyreferendumvoters)*
*Defined in [Combined.ts:42](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L42)*
*Defined in [Combined.ts:42](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L42)*
**Parameters:**
@@ -301,7 +301,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyReferendums](_combined_.apicombined.md#democracyreferendums)*
*Defined in [Combined.ts:58](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L58)*
*Defined in [Combined.ts:58](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L58)*
**Returns:** `Observable`<`Array`<[RxReferendum](_classes_.rxreferendum.md)>>
@@ -314,7 +314,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersBalancesOf](_combined_.apicombined.md#democracyvotersbalancesof)*
*Defined in [Combined.ts:87](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L87)*
*Defined in [Combined.ts:87](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L87)*
**Parameters:**
@@ -333,7 +333,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotersVotesOf](_combined_.apicombined.md#democracyvotersvotesof)*
*Defined in [Combined.ts:103](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L103)*
*Defined in [Combined.ts:103](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L103)*
**Parameters:**
@@ -352,7 +352,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[democracyVotesOf](_combined_.apicombined.md#democracyvotesof)*
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L79)*
*Defined in [Combined.ts:79](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L79)*
**Parameters:**
@@ -372,7 +372,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[democracyVotingPeriod](_queries_.apiqueries.md#democracyvotingperiod)*
*Defined in [Queries.ts:91](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L91)*
*Defined in [Queries.ts:91](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L91)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -385,7 +385,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockLength](_combined_.apicombined.md#erablocklength)*
*Defined in [Combined.ts:114](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L114)*
*Defined in [Combined.ts:114](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L114)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -398,7 +398,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockProgress](_combined_.apicombined.md#erablockprogress)*
*Defined in [Combined.ts:129](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L129)*
*Defined in [Combined.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L129)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -411,7 +411,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[eraBlockRemaining](_combined_.apicombined.md#erablockremaining)*
*Defined in [Combined.ts:151](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L151)*
*Defined in [Combined.ts:151](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L151)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -424,7 +424,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[eraLastLengthChange](_queries_.apiqueries.md#eralastlengthchange)*
*Defined in [Queries.ts:116](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L116)*
*Defined in [Queries.ts:116](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L116)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -437,7 +437,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[fees](_queries_.apiqueries.md#fees)*
*Defined in [Queries.ts:95](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L95)*
*Defined in [Queries.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L95)*
**Returns:** `Observable`<[RxFees](../modules/_types_d_.md#rxfees)>
@@ -450,7 +450,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L36)*
*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L36)*
**Returns:** `Observable`<`boolean`>
@@ -463,7 +463,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L40)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L40)*
**Type parameters:**
@@ -486,7 +486,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L52)*
*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L52)*
**Type parameters:**
@@ -509,7 +509,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L63)*
*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L63)*
**Type parameters:**
@@ -531,7 +531,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockProgress](_combined_.apicombined.md#sessionblockprogress)*
*Defined in [Combined.ts:166](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L166)*
*Defined in [Combined.ts:166](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L166)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -544,7 +544,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBlockRemaining](_combined_.apicombined.md#sessionblockremaining)*
*Defined in [Combined.ts:185](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L185)*
*Defined in [Combined.ts:185](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L185)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -557,7 +557,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionBrokenValue](_combined_.apicombined.md#sessionbrokenvalue)*
*Defined in [Combined.ts:200](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L200)*
*Defined in [Combined.ts:200](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L200)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -570,7 +570,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentIndex](_queries_.apiqueries.md#sessioncurrentindex)*
*Defined in [Queries.ts:128](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L128)*
*Defined in [Queries.ts:128](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L128)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -583,7 +583,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionCurrentStart](_queries_.apiqueries.md#sessioncurrentstart)*
*Defined in [Queries.ts:132](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L132)*
*Defined in [Queries.ts:132](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L132)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -596,7 +596,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLastLengthChange](_queries_.apiqueries.md#sessionlastlengthchange)*
*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L136)*
*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L136)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -609,7 +609,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionLength](_queries_.apiqueries.md#sessionlength)*
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L140)*
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L140)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -622,7 +622,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionReward](_queries_.apiqueries.md#sessionreward)*
*Defined in [Queries.ts:120](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L120)*
*Defined in [Queries.ts:120](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L120)*
**Returns:** `Observable`< `Perbill` &#124; `undefined`>
@@ -635,7 +635,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionRewardCurrent](_queries_.apiqueries.md#sessionrewardcurrent)*
*Defined in [Queries.ts:124](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L124)*
*Defined in [Queries.ts:124](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L124)*
**Returns:** `Observable`< `Balance` &#124; `undefined`>
@@ -648,7 +648,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeExpected](_combined_.apicombined.md#sessiontimeexpected)*
*Defined in [Combined.ts:219](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L219)*
*Defined in [Combined.ts:219](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L219)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -661,7 +661,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[sessionTimeRemaining](_combined_.apicombined.md#sessiontimeremaining)*
*Defined in [Combined.ts:234](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L234)*
*Defined in [Combined.ts:234](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L234)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -674,7 +674,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionValidators](_queries_.apiqueries.md#sessionvalidators)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L148)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L148)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -687,7 +687,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[sessionsPerEra](_queries_.apiqueries.md#sessionsperera)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L144)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L144)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -700,7 +700,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingFreeBalanceOf](_queries_.apiqueries.md#stakingfreebalanceof)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L171)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L171)*
**Parameters:**
@@ -719,7 +719,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingIntentions](_queries_.apiqueries.md#stakingintentions)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L159)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L159)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -732,7 +732,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominating](_queries_.apiqueries.md#stakingnominating)*
*Defined in [Queries.ts:186](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L186)*
*Defined in [Queries.ts:186](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L186)*
**Parameters:**
@@ -751,7 +751,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingNominatorsFor](_queries_.apiqueries.md#stakingnominatorsfor)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L175)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L175)*
**Parameters:**
@@ -770,7 +770,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[stakingReservedBalanceOf](_queries_.apiqueries.md#stakingreservedbalanceof)*
*Defined in [Queries.ts:191](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L191)*
*Defined in [Queries.ts:191](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L191)*
**Parameters:**
@@ -789,7 +789,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[systemAccountIndexOf](_queries_.apiqueries.md#systemaccountindexof)*
*Defined in [Queries.ts:203](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L203)*
*Defined in [Queries.ts:203](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L203)*
**Parameters:**
@@ -808,7 +808,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[timestampBlockPeriod](_queries_.apiqueries.md#timestampblockperiod)*
*Defined in [Queries.ts:195](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L195)*
*Defined in [Queries.ts:195](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L195)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -821,7 +821,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[timestampNow](_queries_.apiqueries.md#timestampnow)*
*Defined in [Queries.ts:199](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L199)*
*Defined in [Queries.ts:199](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L199)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -834,7 +834,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalance](_combined_.apicombined.md#validatingbalance)*
*Defined in [Combined.ts:249](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L249)*
*Defined in [Combined.ts:249](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L249)*
**Parameters:**
@@ -853,7 +853,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[validatingBalances](_combined_.apicombined.md#validatingbalances)*
*Defined in [Combined.ts:274](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L274)*
*Defined in [Combined.ts:274](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L274)*
**Parameters:**
@@ -872,7 +872,7 @@ ___
*Inherited from [ApiQueries](_queries_.apiqueries.md).[validatorCount](_queries_.apiqueries.md#validatorcount)*
*Defined in [Queries.ts:207](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L207)*
*Defined in [Queries.ts:207](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L207)*
**Returns:** `Observable`<`u32`>
@@ -885,7 +885,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalance](_combined_.apicombined.md#votingbalance)*
*Defined in [Combined.ts:288](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L288)*
*Defined in [Combined.ts:288](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L288)*
**Parameters:**
@@ -904,7 +904,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalances](_combined_.apicombined.md#votingbalances)*
*Defined in [Combined.ts:322](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L322)*
*Defined in [Combined.ts:322](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L322)*
**Parameters:**
@@ -923,7 +923,7 @@ ___
*Inherited from [ApiCombined](_combined_.apicombined.md).[votingBalancesNominatorsFor](_combined_.apicombined.md#votingbalancesnominatorsfor)*
*Defined in [Combined.ts:311](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Combined.ts#L311)*
*Defined in [Combined.ts:311](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Combined.ts#L311)*
**Parameters:**
docs/api-observable/classes/_queries_.apiqueries.md
+35 -35
View File
@@ -18,7 +18,7 @@
*Inherited from [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L22)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L22)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[api](_base_.apibase.md#api)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L22)*
*Defined in [Base.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L22)*
___
@@ -54,7 +54,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[combine](_base_.apibase.md#combine)*
*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L28)*
*Defined in [Base.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L28)*
**Type parameters:**
@@ -76,7 +76,7 @@ ___
▸ **democacyVoteOf**(index: * `ReferendumIndex` &#124; `BN` &#124; `number`*, address: * `AccountId` &#124; `string`*): `Observable`<`Bool`>
*Defined in [Queries.ts:76](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L76)*
*Defined in [Queries.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L76)*
**Parameters:**
@@ -94,7 +94,7 @@ ___
▸ **democacyVotersFor**(index: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`<`Array`<`AccountId`>>
*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L80)*
*Defined in [Queries.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L80)*
**Parameters:**
@@ -111,7 +111,7 @@ ___
▸ **democracyLaunchPeriod**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L19)*
*Defined in [Queries.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L19)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -122,7 +122,7 @@ ___
▸ **democracyNextTally**(): `Observable`< `ReferendumIndex` &#124; `undefined`>
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L23)*
*Defined in [Queries.ts:23](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L23)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -133,7 +133,7 @@ ___
▸ **democracyProposalDeposits**(proposalId: * `PropIndex` &#124; `BN` &#124; `number`*): `Observable`< [RxProposalDeposits](_classes_.rxproposaldeposits.md) &#124; `undefined`>
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L27)*
*Defined in [Queries.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L27)*
**Parameters:**
@@ -150,7 +150,7 @@ ___
▸ **democracyPublicProposals**(): `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
*Defined in [Queries.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L40)*
*Defined in [Queries.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L40)*
**Returns:** `Observable`<`Array`<[RxProposal](_classes_.rxproposal.md)>>
@@ -161,7 +161,7 @@ ___
▸ **democracyReferendumCount**(): `Observable`< `ReferendumIndex` &#124; `undefined`>
*Defined in [Queries.ts:59](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L59)*
*Defined in [Queries.ts:59](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L59)*
**Returns:** `Observable`< `ReferendumIndex` &#124; `undefined`>
@@ -172,7 +172,7 @@ ___
▸ **democracyReferendumInfoOf**(referendumId: * `ReferendumIndex` &#124; `BN` &#124; `number`*): `Observable`< [RxReferendum](_classes_.rxreferendum.md) &#124; `undefined`>
*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L63)*
*Defined in [Queries.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L63)*
**Parameters:**
@@ -189,7 +189,7 @@ ___
▸ **democracyVotingPeriod**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:91](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L91)*
*Defined in [Queries.ts:91](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L91)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -200,7 +200,7 @@ ___
▸ **eraLastLengthChange**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:116](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L116)*
*Defined in [Queries.ts:116](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L116)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -211,7 +211,7 @@ ___
▸ **fees**(): `Observable`<[RxFees](../modules/_types_d_.md#rxfees)>
*Defined in [Queries.ts:95](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L95)*
*Defined in [Queries.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L95)*
**Returns:** `Observable`<[RxFees](../modules/_types_d_.md#rxfees)>
@@ -224,7 +224,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[isConnected](_base_.apibase.md#isconnected)*
*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L36)*
*Defined in [Base.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L36)*
**Returns:** `Observable`<`boolean`>
@@ -237,7 +237,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawCall](_base_.apibase.md#rawcall)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L40)*
*Defined in [Base.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L40)*
**Type parameters:**
@@ -260,7 +260,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorage](_base_.apibase.md#rawstorage)*
*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L52)*
*Defined in [Base.ts:52](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L52)*
**Type parameters:**
@@ -283,7 +283,7 @@ ___
*Inherited from [ApiBase](_base_.apibase.md).[rawStorageMulti](_base_.apibase.md#rawstoragemulti)*
*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Base.ts#L63)*
*Defined in [Base.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Base.ts#L63)*
**Type parameters:**
@@ -303,7 +303,7 @@ ___
▸ **sessionCurrentIndex**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:128](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L128)*
*Defined in [Queries.ts:128](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L128)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -314,7 +314,7 @@ ___
▸ **sessionCurrentStart**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Queries.ts:132](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L132)*
*Defined in [Queries.ts:132](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L132)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -325,7 +325,7 @@ ___
▸ **sessionLastLengthChange**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L136)*
*Defined in [Queries.ts:136](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L136)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -336,7 +336,7 @@ ___
▸ **sessionLength**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L140)*
*Defined in [Queries.ts:140](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L140)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -347,7 +347,7 @@ ___
▸ **sessionReward**(): `Observable`< `Perbill` &#124; `undefined`>
*Defined in [Queries.ts:120](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L120)*
*Defined in [Queries.ts:120](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L120)*
**Returns:** `Observable`< `Perbill` &#124; `undefined`>
@@ -358,7 +358,7 @@ ___
▸ **sessionRewardCurrent**(): `Observable`< `Balance` &#124; `undefined`>
*Defined in [Queries.ts:124](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L124)*
*Defined in [Queries.ts:124](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L124)*
**Returns:** `Observable`< `Balance` &#124; `undefined`>
@@ -369,7 +369,7 @@ ___
▸ **sessionValidators**(): `Observable`<`Array`<`AccountId`>>
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L148)*
*Defined in [Queries.ts:148](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L148)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -380,7 +380,7 @@ ___
▸ **sessionsPerEra**(): `Observable`< `BlockNumber` &#124; `undefined`>
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L144)*
*Defined in [Queries.ts:144](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L144)*
**Returns:** `Observable`< `BlockNumber` &#124; `undefined`>
@@ -391,7 +391,7 @@ ___
▸ **stakingFreeBalanceOf**(address: * `AccountId` &#124; `string`*): `Observable`< `Balance` &#124; `undefined`>
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L171)*
*Defined in [Queries.ts:171](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L171)*
**Parameters:**
@@ -408,7 +408,7 @@ ___
▸ **stakingIntentions**(): `Observable`<`Array`<`AccountId`>>
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L159)*
*Defined in [Queries.ts:159](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L159)*
**Returns:** `Observable`<`Array`<`AccountId`>>
@@ -419,7 +419,7 @@ ___
▸ **stakingNominating**(address: * `AccountId` &#124; `string`*): `Observable`< `AccountId` &#124; `undefined`>
*Defined in [Queries.ts:186](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L186)*
*Defined in [Queries.ts:186](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L186)*
**Parameters:**
@@ -436,7 +436,7 @@ ___
▸ **stakingNominatorsFor**(address: * `AccountId` &#124; `string`*): `Observable`<`Array`<`AccountId`>>
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L175)*
*Defined in [Queries.ts:175](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L175)*
**Parameters:**
@@ -453,7 +453,7 @@ ___
▸ **stakingReservedBalanceOf**(address: * `AccountId` &#124; `string`*): `Observable`< `Balance` &#124; `undefined`>
*Defined in [Queries.ts:191](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L191)*
*Defined in [Queries.ts:191](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L191)*
**Parameters:**
@@ -470,7 +470,7 @@ ___
▸ **systemAccountIndexOf**(address: * `AccountId` &#124; `string`*): `Observable`< `Index` &#124; `undefined`>
*Defined in [Queries.ts:203](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L203)*
*Defined in [Queries.ts:203](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L203)*
**Parameters:**
@@ -487,7 +487,7 @@ ___
▸ **timestampBlockPeriod**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Queries.ts:195](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L195)*
*Defined in [Queries.ts:195](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L195)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -498,7 +498,7 @@ ___
▸ **timestampNow**(): `Observable`< `Moment` &#124; `undefined`>
*Defined in [Queries.ts:199](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L199)*
*Defined in [Queries.ts:199](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L199)*
**Returns:** `Observable`< `Moment` &#124; `undefined`>
@@ -509,7 +509,7 @@ ___
▸ **validatorCount**(): `Observable`<`u32`>
*Defined in [Queries.ts:207](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/Queries.ts#L207)*
*Defined in [Queries.ts:207](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/Queries.ts#L207)*
**Returns:** `Observable`<`u32`>
docs/api-observable/modules/_types_d_.md
+5 -5
View File
@@ -9,7 +9,7 @@
**Ƭ ApiFunctions**: * `keyof ApiBase` &#124; `keyof ApiCalls` &#124; `keyof ApiCombined` &#124; `keyof ApiQueries`
*
*Defined in [types.d.ts:14](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/types.d.ts#L14)*
*Defined in [types.d.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/types.d.ts#L14)*
___
<a id="rxbalance"></a>
@@ -18,7 +18,7 @@ ___
**Ƭ RxBalance**: *`object`*
*Defined in [types.d.ts:16](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/types.d.ts#L16)*
*Defined in [types.d.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/types.d.ts#L16)*
#### Type declaration
@@ -29,7 +29,7 @@ ___
**Ƭ RxBalanceMap**: *`object`*
*Defined in [types.d.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/types.d.ts#L40)*
*Defined in [types.d.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/types.d.ts#L40)*
#### Type declaration
@@ -42,7 +42,7 @@ ___
**Ƭ RxFees**: *`object`*
*Defined in [types.d.ts:26](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/types.d.ts#L26)*
*Defined in [types.d.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/types.d.ts#L26)*
#### Type declaration
@@ -53,7 +53,7 @@ ___
**Ƭ RxReferendumVote**: *`object`*
*Defined in [types.d.ts:34](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-observable/src/types.d.ts#L34)*
*Defined in [types.d.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-observable/src/types.d.ts#L34)*
#### Type declaration
docs/api-provider/classes/_http_index_.httpprovider.html
+7 -7
View File
@@ -383,7 +383,7 @@
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new HttpProvider</strong>(endpoint: <em><code>string</code></em>): <a href="_http_index_.httpprovider.html">HttpProvider</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/http/index.ts#L35" target="_blank">http/index.ts:35</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/http/index.ts#L35" target="_blank">http/index.ts:35</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -406,7 +406,7 @@
<h2 id="isconnected">isConnected</h2>
<p>&#x25B8; <strong>isConnected</strong>(): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_d_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_d_.providerinterface.md#isconnected">isConnected</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/http/index.ts#L49" target="_blank">http/index.ts:49</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/http/index.ts#L49" target="_blank">http/index.ts:49</a></em></p>
<p>Whether the node is connected or not.</p>
<p><strong>Returns:</strong> <code>boolean</code>
true if connected</p>
@@ -415,7 +415,7 @@ true if connected</p>
<h2 id="on">on</h2>
<p>&#x25B8; <strong>on</strong>(type: <em><a href="../modules/_types_d_.md#providerinterface_emitted">ProviderInterface$Emitted</a></em>, sub: <em><a href="../modules/_types_d_.md#providerinterface_emitcb">ProviderInterface$EmitCb</a></em>): <code>void</code></p>
<p><em>Implementation of <a href="../interfaces/_types_d_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_d_.providerinterface.md#on">on</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/http/index.ts#L56" target="_blank">http/index.ts:56</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/http/index.ts#L56" target="_blank">http/index.ts:56</a></em></p>
<p>Events are not supported with the HttpProvider, see <a href="_ws_index_.wsprovider.html">WsProvider</a>.</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -442,7 +442,7 @@ true if connected</p>
<h2 id="send">send</h2>
<p>&#x25B8; <strong>send</strong>(method: <em><code>string</code></em>, params: <em><code>Array</code>&lt;<code>any</code>&gt;</em>): <code>Promise</code>&lt;<code>any</code>&gt;</p>
<p><em>Implementation of <a href="../interfaces/_types_d_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_d_.providerinterface.md#send">send</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/http/index.ts#L60" target="_blank">http/index.ts:60</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/http/index.ts#L60" target="_blank">http/index.ts:60</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -468,7 +468,7 @@ true if connected</p>
<h2 id="subscribe">subscribe</h2>
<p>&#x25B8; <strong>subscribe</strong>(types: <em><code>string</code></em>, method: <em><code>string</code></em>, params: <em><code>Array</code>&lt;<code>any</code>&gt;</em>, cb: <em><a href="../modules/_types_d_.md#providerinterface_callback">ProviderInterface$Callback</a></em>): <code>Promise</code>&lt;<code>number</code>&gt;</p>
<p><em>Implementation of <a href="../interfaces/_types_d_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_d_.providerinterface.md#subscribe">subscribe</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/http/index.ts#L82" target="_blank">http/index.ts:82</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/http/index.ts#L82" target="_blank">http/index.ts:82</a></em></p>
<p>Subscriptions are not supported with the HttpProvider, see <a href="_ws_index_.wsprovider.html">WsProvider</a>.</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -503,7 +503,7 @@ true if connected</p>
<h2 id="unsubscribe">unsubscribe</h2>
<p>&#x25B8; <strong>unsubscribe</strong>(type: <em><code>string</code></em>, method: <em><code>string</code></em>, id: <em><code>number</code></em>): <code>Promise</code>&lt;<code>boolean</code>&gt;</p>
<p><em>Implementation of <a href="../interfaces/_types_d_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_d_.providerinterface.md#unsubscribe">unsubscribe</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/http/index.ts#L91" target="_blank">http/index.ts:91</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/http/index.ts#L91" target="_blank">http/index.ts:91</a></em></p>
<p>Subscriptions are not supported with the HttpProvider, see <a href="_ws_index_.wsprovider.html">WsProvider</a>.</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -573,7 +573,7 @@ true if connected</p>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"HttpProvider","level":"1.3.1","depth":2,"next":{"title":"WsProvider","level":"1.3.2","depth":2,"path":"api-provider/classes/_ws_index_.wsprovider.md","ref":"api-provider/classes/_ws_index_.wsprovider.md","articles":[]},"previous":{"title":"api-provider","level":"1.3","depth":1,"path":"api-provider/README.md","ref":"api-provider/README.md","articles":[{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"api-provider/classes/_http_index_.httpprovider.md","ref":"api-provider/classes/_http_index_.httpprovider.md","articles":[]},{"title":"WsProvider","level":"1.3.2","depth":2,"path":"api-provider/classes/_ws_index_.wsprovider.md","ref":"api-provider/classes/_ws_index_.wsprovider.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api-provider/classes/_http_index_.httpprovider.md","mtime":"2018-10-02T09:13:22.918Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:13:59.444Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"HttpProvider","level":"1.3.1","depth":2,"next":{"title":"WsProvider","level":"1.3.2","depth":2,"path":"api-provider/classes/_ws_index_.wsprovider.md","ref":"api-provider/classes/_ws_index_.wsprovider.md","articles":[]},"previous":{"title":"api-provider","level":"1.3","depth":1,"path":"api-provider/README.md","ref":"api-provider/README.md","articles":[{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"api-provider/classes/_http_index_.httpprovider.md","ref":"api-provider/classes/_http_index_.httpprovider.md","articles":[]},{"title":"WsProvider","level":"1.3.2","depth":2,"path":"api-provider/classes/_ws_index_.wsprovider.md","ref":"api-provider/classes/_ws_index_.wsprovider.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api-provider/classes/_http_index_.httpprovider.md","mtime":"2018-10-02T09:33:42.502Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:34:30.873Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/api-provider/classes/_http_index_.httpprovider.md
+6 -6
View File
@@ -23,7 +23,7 @@ const provider = new WsProvider('[http://127.0.0.1:9933')](http://127.0.0.1:9933
⊕ **new HttpProvider**(endpoint: *`string`*): [HttpProvider](_http_index_.httpprovider.md)
*Defined in [http/index.ts:35](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/http/index.ts#L35)*
*Defined in [http/index.ts:35](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/http/index.ts#L35)*
**Parameters:**
@@ -45,7 +45,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[isConnected](../interfaces/_types_d_.providerinterface.md#isconnected)*
*Defined in [http/index.ts:49](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/http/index.ts#L49)*
*Defined in [http/index.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/http/index.ts#L49)*
Whether the node is connected or not.
@@ -61,7 +61,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[on](../interfaces/_types_d_.providerinterface.md#on)*
*Defined in [http/index.ts:56](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/http/index.ts#L56)*
*Defined in [http/index.ts:56](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/http/index.ts#L56)*
Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
@@ -83,7 +83,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[send](../interfaces/_types_d_.providerinterface.md#send)*
*Defined in [http/index.ts:60](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/http/index.ts#L60)*
*Defined in [http/index.ts:60](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/http/index.ts#L60)*
**Parameters:**
@@ -103,7 +103,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[subscribe](../interfaces/_types_d_.providerinterface.md#subscribe)*
*Defined in [http/index.ts:82](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/http/index.ts#L82)*
*Defined in [http/index.ts:82](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/http/index.ts#L82)*
Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
@@ -127,7 +127,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[unsubscribe](../interfaces/_types_d_.providerinterface.md#unsubscribe)*
*Defined in [http/index.ts:91](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/http/index.ts#L91)*
*Defined in [http/index.ts:91](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/http/index.ts#L91)*
Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
docs/api-provider/classes/_ws_index_.wsprovider.html
+8 -8
View File
@@ -385,7 +385,7 @@
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new WsProvider</strong>(endpoint: <em><code>string</code></em>, autoConnect?: <em><code>boolean</code></em>): <a href="_ws_index_.wsprovider.html">WsProvider</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/ws/index.ts#L67" target="_blank">ws/index.ts:67</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/ws/index.ts#L67" target="_blank">ws/index.ts:67</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -455,7 +455,7 @@
<p><a id="connect"></a></p>
<h2 id="connect">connect</h2>
<p>&#x25B8; <strong>connect</strong>(): <code>void</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/ws/index.ts#L97" target="_blank">ws/index.ts:97</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/ws/index.ts#L97" target="_blank">ws/index.ts:97</a></em></p>
<p>The <a href="_ws_index_.wsprovider.html">WsProvider</a> connects automatically by default. if you decided otherwise, you may connect manually using this method.</p>
<p><strong>Returns:</strong> <code>void</code></p>
<hr>
@@ -497,7 +497,7 @@
<p><a id="isconnected"></a></p>
<h2 id="isconnected">isConnected</h2>
<p>&#x25B8; <strong>isConnected</strong>(): <code>boolean</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/ws/index.ts#L114" target="_blank">ws/index.ts:114</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/ws/index.ts#L114" target="_blank">ws/index.ts:114</a></em></p>
<p>Whether the node is connected or not.</p>
<p><strong>Returns:</strong> <code>boolean</code>
true if connected</p>
@@ -586,7 +586,7 @@ true if connected</p>
<h2 id="on">on</h2>
<p>&#x25B8; <strong>on</strong>(type: <em><a href="../modules/_types_d_.md#providerinterface_emitted">ProviderInterface$Emitted</a></em>, sub: <em><a href="../modules/_types_d_.md#providerinterface_emitcb">ProviderInterface$EmitCb</a></em>): <code>this</code></p>
<p><em>Overrides EventEmitter.on</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/ws/index.ts#L124" target="_blank">ws/index.ts:124</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/ws/index.ts#L124" target="_blank">ws/index.ts:124</a></em></p>
<p>Listens on events after having subscribed using the <a href="_ws_index_.wsprovider.html#subscribe">subscribe</a> function.</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -705,7 +705,7 @@ true if connected</p>
<p><a id="send"></a></p>
<h2 id="send">send</h2>
<p>&#x25B8; <strong>send</strong>(method: <em><code>string</code></em>, params: <em><code>Array</code>&lt;<code>any</code>&gt;</em>, subscription?: <em><code>SubscriptionHandler</code></em>): <code>Promise</code>&lt;<code>any</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/ws/index.ts#L128" target="_blank">ws/index.ts:128</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/ws/index.ts#L128" target="_blank">ws/index.ts:128</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -734,7 +734,7 @@ true if connected</p>
<p><a id="subscribe"></a></p>
<h2 id="subscribe">subscribe</h2>
<p>&#x25B8; <strong>subscribe</strong>(type: <em><code>string</code></em>, method: <em><code>string</code></em>, params: <em><code>Array</code>&lt;<code>any</code>&gt;</em>, callback: <em><a href="../modules/_types_d_.md#providerinterface_callback">ProviderInterface$Callback</a></em>): <code>Promise</code>&lt;<code>number</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/ws/index.ts#L179" target="_blank">ws/index.ts:179</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/ws/index.ts#L179" target="_blank">ws/index.ts:179</a></em></p>
<p>Allows subscribing to a specific event.
<em><strong>example</strong></em>: const provider = new WsProvider(&apos;ws://127.0.0.1:9944&apos;); const api = createApi(provider);</p>
<p>api.state.storage([[storage.balances.freeBalance,</p>
@@ -777,7 +777,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
<p><a id="unsubscribe"></a></p>
<h2 id="unsubscribe">unsubscribe</h2>
<p>&#x25B8; <strong>unsubscribe</strong>(type: <em><code>string</code></em>, method: <em><code>string</code></em>, id: <em><code>number</code></em>): <code>Promise</code>&lt;<code>boolean</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/ws/index.ts#L188" target="_blank">ws/index.ts:188</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/ws/index.ts#L188" target="_blank">ws/index.ts:188</a></em></p>
<p>Allows unsubscribing to subscriptions made with <a href="_ws_index_.wsprovider.html#subscribe">subscribe</a>.</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -847,7 +847,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"WsProvider","level":"1.3.2","depth":2,"next":{"title":"api-rx","level":"1.4","depth":1,"path":"api-rx/README.md","ref":"api-rx/README.md","articles":[{"title":"ApiRx","level":"1.4.1","depth":2,"path":"api-rx/classes/_index_.rxapi.md","ref":"api-rx/classes/_index_.rxapi.md","articles":[]}]},"previous":{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"api-provider/classes/_http_index_.httpprovider.md","ref":"api-provider/classes/_http_index_.httpprovider.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api-provider/classes/_ws_index_.wsprovider.md","mtime":"2018-10-02T09:13:22.998Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:13:59.444Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"WsProvider","level":"1.3.2","depth":2,"next":{"title":"api-rx","level":"1.4","depth":1,"path":"api-rx/README.md","ref":"api-rx/README.md","articles":[{"title":"ApiRx","level":"1.4.1","depth":2,"path":"api-rx/classes/_index_.rxapi.md","ref":"api-rx/classes/_index_.rxapi.md","articles":[]}]},"previous":{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"api-provider/classes/_http_index_.httpprovider.md","ref":"api-provider/classes/_http_index_.httpprovider.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api-provider/classes/_ws_index_.wsprovider.md","mtime":"2018-10-02T09:33:42.610Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:34:30.873Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/api-provider/classes/_ws_index_.wsprovider.md
+7 -7
View File
@@ -26,7 +26,7 @@ The WebSocket Provider allows sending requests using WebSocket. Unlike the [Http
⊕ **new WsProvider**(endpoint: *`string`*, autoConnect?: *`boolean`*): [WsProvider](_ws_index_.wsprovider.md)
*Defined in [ws/index.ts:67](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/ws/index.ts#L67)*
*Defined in [ws/index.ts:67](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/ws/index.ts#L67)*
**Parameters:**
@@ -83,7 +83,7 @@ ___
▸ **connect**(): `void`
*Defined in [ws/index.ts:97](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/ws/index.ts#L97)*
*Defined in [ws/index.ts:97](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/ws/index.ts#L97)*
The [WsProvider](_ws_index_.wsprovider.md) connects automatically by default. if you decided otherwise, you may connect manually using this method.
@@ -133,7 +133,7 @@ ___
▸ **isConnected**(): `boolean`
*Defined in [ws/index.ts:114](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/ws/index.ts#L114)*
*Defined in [ws/index.ts:114](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/ws/index.ts#L114)*
Whether the node is connected or not.
@@ -213,7 +213,7 @@ ___
*Overrides EventEmitter.on*
*Defined in [ws/index.ts:124](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/ws/index.ts#L124)*
*Defined in [ws/index.ts:124](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/ws/index.ts#L124)*
Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function.
@@ -302,7 +302,7 @@ ___
▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`>
*Defined in [ws/index.ts:128](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/ws/index.ts#L128)*
*Defined in [ws/index.ts:128](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/ws/index.ts#L128)*
**Parameters:**
@@ -321,7 +321,7 @@ ___
▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *[ProviderInterface$Callback](../modules/_types_d_.md#providerinterface_callback)*): `Promise`<`number`>
*Defined in [ws/index.ts:179](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/ws/index.ts#L179)*
*Defined in [ws/index.ts:179](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/ws/index.ts#L179)*
Allows subscribing to a specific event.
*__example__*: const provider = new WsProvider('ws://127.0.0.1:9944'); const api = createApi(provider);
@@ -349,7 +349,7 @@ ___
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
*Defined in [ws/index.ts:188](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/ws/index.ts#L188)*
*Defined in [ws/index.ts:188](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/ws/index.ts#L188)*
Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe).
docs/api-provider/index.html
+1 -1
View File
@@ -426,7 +426,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"api-provider","level":"1.3","depth":1,"next":{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"api-provider/classes/_http_index_.httpprovider.md","ref":"api-provider/classes/_http_index_.httpprovider.md","articles":[]},"previous":{"title":"Api","level":"1.2.1","depth":2,"path":"api/classes/_index_.api.md","ref":"api/classes/_index_.api.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api-provider/README.md","mtime":"2018-10-02T09:13:22.762Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:13:59.444Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"api-provider","level":"1.3","depth":1,"next":{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"api-provider/classes/_http_index_.httpprovider.md","ref":"api-provider/classes/_http_index_.httpprovider.md","articles":[]},"previous":{"title":"Api","level":"1.2.1","depth":2,"path":"api/classes/_index_.api.md","ref":"api/classes/_index_.api.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api-provider/README.md","mtime":"2018-10-02T09:33:42.322Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:34:30.873Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/api-provider/interfaces/_types_d_.providerinterface.md
+5 -5
View File
@@ -16,7 +16,7 @@
▸ **isConnected**(): `boolean`
*Defined in [types.d.ts:45](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L45)*
*Defined in [types.d.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L45)*
**Returns:** `boolean`
@@ -27,7 +27,7 @@ ___
▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_d_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_d_.md#providerinterface_emitcb)*): `void`
*Defined in [types.d.ts:46](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L46)*
*Defined in [types.d.ts:46](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L46)*
**Parameters:**
@@ -45,7 +45,7 @@ ___
▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`>
*Defined in [types.d.ts:47](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L47)*
*Defined in [types.d.ts:47](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L47)*
**Parameters:**
@@ -63,7 +63,7 @@ ___
▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *[ProviderInterface$Callback](../modules/_types_d_.md#providerinterface_callback)*): `Promise`<`number`>
*Defined in [types.d.ts:48](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L48)*
*Defined in [types.d.ts:48](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L48)*
**Parameters:**
@@ -83,7 +83,7 @@ ___
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
*Defined in [types.d.ts:49](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L49)*
*Defined in [types.d.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L49)*
**Parameters:**
docs/api-provider/modules/_coder_json_decoderesponse_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **decodeResponse**(self: *[RpcCoderState](_coder_json_types_d_.md#rpccoderstate)*, response: *[JsonRpcResponse](_types_d_.md#jsonrpcresponse)*): `any`
*Defined in [coder/json/decodeResponse.ts:22](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/coder/json/decodeResponse.ts#L22)*
*Defined in [coder/json/decodeResponse.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/coder/json/decodeResponse.ts#L22)*
**Parameters:**
docs/api-provider/modules/_coder_json_encodejson_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **encodeJson**(self: *[RpcCoderState](_coder_json_types_d_.md#rpccoderstate)*, method: *`string`*, params: *`Array`<`any`>*): `string`
*Defined in [coder/json/encodeJson.ts:9](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/coder/json/encodeJson.ts#L9)*
*Defined in [coder/json/encodeJson.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/coder/json/encodeJson.ts#L9)*
**Parameters:**
docs/api-provider/modules/_coder_json_encodeobject_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **encodeObject**(self: *[RpcCoderState](_coder_json_types_d_.md#rpccoderstate)*, method: *`string`*, params: *`Array`<`any`>*): [JsonRpcRequest](_types_d_.md#jsonrpcrequest)
*Defined in [coder/json/encodeObject.ts:8](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/coder/json/encodeObject.ts#L8)*
*Defined in [coder/json/encodeObject.ts:8](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/coder/json/encodeObject.ts#L8)*
**Parameters:**
docs/api-provider/modules/_coder_json_index_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **rpcCoder**(): [RpcCoder](_coder_json_types_d_.md#rpccoder)
*Defined in [coder/json/index.ts:12](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/coder/json/index.ts#L12)*
*Defined in [coder/json/index.ts:12](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/coder/json/index.ts#L12)*
**Returns:** [RpcCoder](_coder_json_types_d_.md#rpccoder)
docs/api-provider/modules/_coder_json_types_d_.md
+2 -2
View File
@@ -8,7 +8,7 @@
**Ƭ RpcCoder**: *`object`*
*Defined in [coder/json/types.d.ts:7](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/coder/json/types.d.ts#L7)*
*Defined in [coder/json/types.d.ts:7](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/coder/json/types.d.ts#L7)*
#### Type declaration
@@ -19,7 +19,7 @@ ___
**Ƭ RpcCoderState**: *`object`*
*Defined in [coder/json/types.d.ts:14](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/coder/json/types.d.ts#L14)*
*Defined in [coder/json/types.d.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/coder/json/types.d.ts#L14)*
#### Type declaration
docs/api-provider/modules/_http_types_d_.md
+1 -1
View File
@@ -8,7 +8,7 @@
**Ƭ HttpState**: *`object`*
*Defined in [http/types.d.ts:8](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/http/types.d.ts#L8)*
*Defined in [http/types.d.ts:8](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/http/types.d.ts#L8)*
#### Type declaration
docs/api-provider/modules/_mock_index_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **mockProvider**(): [ProviderInterface](../interfaces/_types_d_.providerinterface.md)
*Defined in [mock/index.ts:18](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/index.ts#L18)*
*Defined in [mock/index.ts:18](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/index.ts#L18)*
A moock provider mainly used for testing.
docs/api-provider/modules/_mock_mocks_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **mocks**(__namedParameters: *`object`*): `void`
*Defined in [mock/mocks.ts:63](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/mocks.ts#L63)*
*Defined in [mock/mocks.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/mocks.ts#L63)*
**Parameters:**
docs/api-provider/modules/_mock_on_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **on**(self: *[MockState](_mock_types_d_.md#mockstate)*, type: *[ProviderInterface$Emitted](_types_d_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](_types_d_.md#providerinterface_emitcb)*): `void`
*Defined in [mock/on.ts:8](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/on.ts#L8)*
*Defined in [mock/on.ts:8](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/on.ts#L8)*
**Parameters:**
docs/api-provider/modules/_mock_send_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **send**(__namedParameters: *`object`*, method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`>
*Defined in [mock/send.ts:7](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/send.ts#L7)*
*Defined in [mock/send.ts:7](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/send.ts#L7)*
**Parameters:**
docs/api-provider/modules/_mock_state_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **state**(): [MockState](_mock_types_d_.md#mockstate)
*Defined in [mock/state.ts:38](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/state.ts#L38)*
*Defined in [mock/state.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/state.ts#L38)*
**Returns:** [MockState](_mock_types_d_.md#mockstate)
docs/api-provider/modules/_mock_subscribe_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **subscribe**(self: *[MockState](_mock_types_d_.md#mockstate)*, type: *`string`*, method: *`string`*, params: *`Array`<`any`>*): `Promise`<`number`>
*Defined in [mock/subscribe.ts:7](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/subscribe.ts#L7)*
*Defined in [mock/subscribe.ts:7](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/subscribe.ts#L7)*
**Parameters:**
docs/api-provider/modules/_mock_types_d_.md
+5 -5
View File
@@ -8,7 +8,7 @@
**Ƭ MockState**: *`object`*
*Defined in [mock/types.d.ts:27](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/types.d.ts#L27)*
*Defined in [mock/types.d.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/types.d.ts#L27)*
#### Type declaration
@@ -19,7 +19,7 @@ ___
**Ƭ MockState$Db**: *`object`*
*Defined in [mock/types.d.ts:19](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/types.d.ts#L19)*
*Defined in [mock/types.d.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/types.d.ts#L19)*
#### Type declaration
@@ -32,7 +32,7 @@ ___
**Ƭ MockState$Requests**: *`object`*
*Defined in [mock/types.d.ts:23](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/types.d.ts#L23)*
*Defined in [mock/types.d.ts:23](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/types.d.ts#L23)*
#### Type declaration
@@ -56,7 +56,7 @@ ___
**Ƭ MockState$Subscription$Callback**: *`function`*
*Defined in [mock/types.d.ts:8](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/types.d.ts#L8)*
*Defined in [mock/types.d.ts:8](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/types.d.ts#L8)*
#### Type declaration
▸(error: * `Error` &#124; `null`*, value: *`any`*): `void`
@@ -77,7 +77,7 @@ ___
**Ƭ MockState$Subscriptions**: *`object`*
*Defined in [mock/types.d.ts:10](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/types.d.ts#L10)*
*Defined in [mock/types.d.ts:10](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/types.d.ts#L10)*
#### Type declaration
docs/api-provider/modules/_mock_unsubscribe_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **unsubscribe**(self: *[MockState](_mock_types_d_.md#mockstate)*, type: *`string`*, name: *`string`*, id: *`number`*): `Promise`<`boolean`>
*Defined in [mock/unsubscribe.ts:7](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/mock/unsubscribe.ts#L7)*
*Defined in [mock/unsubscribe.ts:7](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/mock/unsubscribe.ts#L7)*
**Parameters:**
docs/api-provider/modules/_types_d_.md
+8 -8
View File
@@ -8,7 +8,7 @@
**Ƭ JsonRpcObject**: *`object`*
*Defined in [types.d.ts:5](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L5)*
*Defined in [types.d.ts:5](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L5)*
#### Type declaration
@@ -20,7 +20,7 @@ ___
**Ƭ JsonRpcRequest**: * [JsonRpcObject](_types_d_.md#jsonrpcobject) & `object`
*
*Defined in [types.d.ts:10](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L10)*
*Defined in [types.d.ts:10](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L10)*
___
<a id="jsonrpcresponse"></a>
@@ -30,7 +30,7 @@ ___
**Ƭ JsonRpcResponse**: * [JsonRpcObject](_types_d_.md#jsonrpcobject) & [JsonRpcResponseBase](_types_d_.md#jsonrpcresponsebase)
*
*Defined in [types.d.ts:36](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L36)*
*Defined in [types.d.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L36)*
___
<a id="jsonrpcresponsebase"></a>
@@ -40,7 +40,7 @@ ___
**Ƭ JsonRpcResponseBase**: * `JsonRpcResponse$Single` & `JsonRpcResponse$Subscription`
*
*Defined in [types.d.ts:34](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L34)*
*Defined in [types.d.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L34)*
___
<a id="jsonrpcresponsebase_error"></a>
@@ -49,7 +49,7 @@ ___
**Ƭ JsonRpcResponseBase$Error**: *`object`*
*Defined in [types.d.ts:15](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L15)*
*Defined in [types.d.ts:15](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L15)*
#### Type declaration
@@ -60,7 +60,7 @@ ___
**Ƭ ProviderInterface$Callback**: *`function`*
*Defined in [types.d.ts:38](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L38)*
*Defined in [types.d.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L38)*
#### Type declaration
▸(error: * `Error` &#124; `null`*, result: *`any`*): `void`
@@ -81,7 +81,7 @@ ___
**Ƭ ProviderInterface$EmitCb**: *`function`*
*Defined in [types.d.ts:42](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L42)*
*Defined in [types.d.ts:42](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L42)*
#### Type declaration
▸(value?: *`any`*): `any`
@@ -102,7 +102,7 @@ ___
**Ƭ ProviderInterface$Emitted**: * "connected" &#124; "disconnected"
*
*Defined in [types.d.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-provider/src/types.d.ts#L40)*
*Defined in [types.d.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-provider/src/types.d.ts#L40)*
___
docs/api-rx/classes/_index_.rxapi.html
+7 -7
View File
@@ -382,7 +382,7 @@
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new RxApi</strong>(provider?: <em><code>ProviderInterface</code></em>): <a href="_index_.rxapi.html">RxApi</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/index.ts#L40" target="_blank">index.ts:40</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/index.ts#L40" target="_blank">index.ts:40</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -408,28 +408,28 @@
<p><a id="author"></a></p>
<h2 id="author">author</h2>
<p><strong>&#x25CF; author</strong>: <em><a href="../modules/_types_d_.md#rxapiinterface_section">RxApiInterface$Section</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/index.ts#L37" target="_blank">index.ts:37</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/index.ts#L37" target="_blank">index.ts:37</a></em></p>
<hr>
<p><a id="chain"></a></p>
<h2 id="chain">chain</h2>
<p><strong>&#x25CF; chain</strong>: <em><a href="../modules/_types_d_.md#rxapiinterface_section">RxApiInterface$Section</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/index.ts#L38" target="_blank">index.ts:38</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/index.ts#L38" target="_blank">index.ts:38</a></em></p>
<hr>
<p><a id="state"></a></p>
<h2 id="state">state</h2>
<p><strong>&#x25CF; state</strong>: <em><a href="../modules/_types_d_.md#rxapiinterface_section">RxApiInterface$Section</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/index.ts#L39" target="_blank">index.ts:39</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/index.ts#L39" target="_blank">index.ts:39</a></em></p>
<hr>
<p><a id="system"></a></p>
<h2 id="system">system</h2>
<p><strong>&#x25CF; system</strong>: <em><a href="../modules/_types_d_.md#rxapiinterface_section">RxApiInterface$Section</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/index.ts#L40" target="_blank">index.ts:40</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/index.ts#L40" target="_blank">index.ts:40</a></em></p>
<hr>
<h1 id="methods">Methods</h1>
<p><a id="isconnected"></a></p>
<h2 id="isconnected">isConnected</h2>
<p>&#x25B8; <strong>isConnected</strong>(): <code>BehaviorSubject</code>&lt;<code>boolean</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/index.ts#L59" target="_blank">index.ts:59</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/index.ts#L59" target="_blank">index.ts:59</a></em></p>
<p><strong>Returns:</strong> <code>BehaviorSubject</code>&lt;<code>boolean</code>&gt;</p>
<hr>
@@ -475,7 +475,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"ApiRx","level":"1.4.1","depth":2,"next":{"title":"Overview","level":"2.1","depth":1,"path":"examples/README.md","ref":"examples/README.md","articles":[]},"previous":{"title":"api-rx","level":"1.4","depth":1,"path":"api-rx/README.md","ref":"api-rx/README.md","articles":[{"title":"ApiRx","level":"1.4.1","depth":2,"path":"api-rx/classes/_index_.rxapi.md","ref":"api-rx/classes/_index_.rxapi.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api-rx/classes/_index_.rxapi.md","mtime":"2018-10-02T09:13:30.950Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:13:59.444Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"ApiRx","level":"1.4.1","depth":2,"next":{"title":"Overview","level":"2.1","depth":1,"path":"examples/README.md","ref":"examples/README.md","articles":[]},"previous":{"title":"api-rx","level":"1.4","depth":1,"path":"api-rx/README.md","ref":"api-rx/README.md","articles":[{"title":"ApiRx","level":"1.4.1","depth":2,"path":"api-rx/classes/_index_.rxapi.md","ref":"api-rx/classes/_index_.rxapi.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api-rx/classes/_index_.rxapi.md","mtime":"2018-10-02T09:33:51.070Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:34:30.873Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/api-rx/classes/_index_.rxapi.md
+6 -6
View File
@@ -21,7 +21,7 @@ const provider = new WsProvider('[http://127.0.0.1:9944')](http://127.0.0.1:9944
⊕ **new RxApi**(provider?: *`ProviderInterface`*): [RxApi](_index_.rxapi.md)
*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/index.ts#L40)*
*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/index.ts#L40)*
**Parameters:**
@@ -41,7 +41,7 @@ ___
**● author**: *[RxApiInterface$Section](../modules/_types_d_.md#rxapiinterface_section)*
*Defined in [index.ts:37](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/index.ts#L37)*
*Defined in [index.ts:37](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/index.ts#L37)*
___
<a id="chain"></a>
@@ -50,7 +50,7 @@ ___
**● chain**: *[RxApiInterface$Section](../modules/_types_d_.md#rxapiinterface_section)*
*Defined in [index.ts:38](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/index.ts#L38)*
*Defined in [index.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/index.ts#L38)*
___
<a id="state"></a>
@@ -59,7 +59,7 @@ ___
**● state**: *[RxApiInterface$Section](../modules/_types_d_.md#rxapiinterface_section)*
*Defined in [index.ts:39](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/index.ts#L39)*
*Defined in [index.ts:39](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/index.ts#L39)*
___
<a id="system"></a>
@@ -68,7 +68,7 @@ ___
**● system**: *[RxApiInterface$Section](../modules/_types_d_.md#rxapiinterface_section)*
*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/index.ts#L40)*
*Defined in [index.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/index.ts#L40)*
___
@@ -80,7 +80,7 @@ ___
▸ **isConnected**(): `BehaviorSubject`<`boolean`>
*Defined in [index.ts:59](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/index.ts#L59)*
*Defined in [index.ts:59](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/index.ts#L59)*
**Returns:** `BehaviorSubject`<`boolean`>
docs/api-rx/index.html
+1 -1
View File
@@ -415,7 +415,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"api-rx","level":"1.4","depth":1,"next":{"title":"ApiRx","level":"1.4.1","depth":2,"path":"api-rx/classes/_index_.rxapi.md","ref":"api-rx/classes/_index_.rxapi.md","articles":[]},"previous":{"title":"WsProvider","level":"1.3.2","depth":2,"path":"api-provider/classes/_ws_index_.wsprovider.md","ref":"api-provider/classes/_ws_index_.wsprovider.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api-rx/README.md","mtime":"2018-10-02T09:13:30.846Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:13:59.444Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"api-rx","level":"1.4","depth":1,"next":{"title":"ApiRx","level":"1.4.1","depth":2,"path":"api-rx/classes/_index_.rxapi.md","ref":"api-rx/classes/_index_.rxapi.md","articles":[]},"previous":{"title":"WsProvider","level":"1.3.2","depth":2,"path":"api-provider/classes/_ws_index_.wsprovider.md","ref":"api-provider/classes/_ws_index_.wsprovider.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api-rx/README.md","mtime":"2018-10-02T09:33:50.958Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:34:30.873Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/api-rx/modules/_types_d_.md
+3 -3
View File
@@ -8,7 +8,7 @@
**Ƭ RxApiInterface**: *`object`*
*Defined in [types.d.ts:15](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/types.d.ts#L15)*
*Defined in [types.d.ts:15](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/types.d.ts#L15)*
#### Type declaration
@@ -19,7 +19,7 @@ ___
**Ƭ RxApiInterface$Method**: *`function`*
*Defined in [types.d.ts:9](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/types.d.ts#L9)*
*Defined in [types.d.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/types.d.ts#L9)*
#### Type declaration
▸(...params: *`Array`<`any`>*): `Observable`<`any`> &#124; `BehaviorSubject`<`any`>
@@ -39,7 +39,7 @@ ___
**Ƭ RxApiInterface$Section**: *`object`*
*Defined in [types.d.ts:11](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api-rx/src/types.d.ts#L11)*
*Defined in [types.d.ts:11](https://github.com/polkadot-js/api/blob/48e57f9/packages/api-rx/src/types.d.ts#L11)*
#### Type declaration
docs/api/classes/_index_.api.html
+7 -7
View File
@@ -381,7 +381,7 @@
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Api</strong>(provider: <em><code>ProviderInterface</code></em>): <a href="_index_.api.html">Api</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/index.ts#L29" target="_blank">index.ts:29</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/index.ts#L29" target="_blank">index.ts:29</a></em></p>
<p><em><strong>constructor</strong></em>: Default constructor for the Api Object</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -406,28 +406,28 @@
<p><a id="author"></a></p>
<h2 id="author">author</h2>
<p><strong>&#x25CF; author</strong>: <em><a href="../modules/_types_d_.md#apiinterface_section">ApiInterface$Section</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/index.ts#L26" target="_blank">index.ts:26</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/index.ts#L26" target="_blank">index.ts:26</a></em></p>
<hr>
<p><a id="chain"></a></p>
<h2 id="chain">chain</h2>
<p><strong>&#x25CF; chain</strong>: <em><a href="../modules/_types_d_.md#apiinterface_section">ApiInterface$Section</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/index.ts#L27" target="_blank">index.ts:27</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/index.ts#L27" target="_blank">index.ts:27</a></em></p>
<hr>
<p><a id="state"></a></p>
<h2 id="state">state</h2>
<p><strong>&#x25CF; state</strong>: <em><a href="../modules/_types_d_.md#apiinterface_section">ApiInterface$Section</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/index.ts#L28" target="_blank">index.ts:28</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/index.ts#L28" target="_blank">index.ts:28</a></em></p>
<hr>
<p><a id="system"></a></p>
<h2 id="system">system</h2>
<p><strong>&#x25CF; system</strong>: <em><a href="../modules/_types_d_.md#apiinterface_section">ApiInterface$Section</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/index.ts#L29" target="_blank">index.ts:29</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/index.ts#L29" target="_blank">index.ts:29</a></em></p>
<hr>
<h1 id="methods">Methods</h1>
<p><a id="signature"></a></p>
<h2 id="static-signature"><code>&lt;Static&gt;</code> signature</h2>
<p>&#x25B8; <strong>signature</strong>(__namedParameters: <em><code>object</code></em>): <code>string</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/index.ts#L58" target="_blank">index.ts:58</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/index.ts#L58" target="_blank">index.ts:58</a></em></p>
<p><em><strong>name</strong></em>: signature</p>
<p><em><strong>signature</strong></em>: jsonrpcSignature (method: InterfaceMethodDefinition): string</p>
<p><em><strong>summary</strong></em>: Returns a string representation of the method with inputs and outputs.</p>
@@ -494,7 +494,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Api","level":"1.2.1","depth":2,"next":{"title":"api-provider","level":"1.3","depth":1,"path":"api-provider/README.md","ref":"api-provider/README.md","articles":[{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"api-provider/classes/_http_index_.httpprovider.md","ref":"api-provider/classes/_http_index_.httpprovider.md","articles":[]},{"title":"WsProvider","level":"1.3.2","depth":2,"path":"api-provider/classes/_ws_index_.wsprovider.md","ref":"api-provider/classes/_ws_index_.wsprovider.md","articles":[]}]},"previous":{"title":"api","level":"1.2","depth":1,"path":"api/README.md","ref":"api/README.md","articles":[{"title":"Api","level":"1.2.1","depth":2,"path":"api/classes/_index_.api.md","ref":"api/classes/_index_.api.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/classes/_index_.api.md","mtime":"2018-10-02T09:13:06.946Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:13:59.444Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Api","level":"1.2.1","depth":2,"next":{"title":"api-provider","level":"1.3","depth":1,"path":"api-provider/README.md","ref":"api-provider/README.md","articles":[{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"api-provider/classes/_http_index_.httpprovider.md","ref":"api-provider/classes/_http_index_.httpprovider.md","articles":[]},{"title":"WsProvider","level":"1.3.2","depth":2,"path":"api-provider/classes/_ws_index_.wsprovider.md","ref":"api-provider/classes/_ws_index_.wsprovider.md","articles":[]}]},"previous":{"title":"api","level":"1.2","depth":1,"path":"api/README.md","ref":"api/README.md","articles":[{"title":"Api","level":"1.2.1","depth":2,"path":"api/classes/_index_.api.md","ref":"api/classes/_index_.api.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/classes/_index_.api.md","mtime":"2018-10-02T09:33:24.566Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:34:30.873Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/api/classes/_index_.api.md
+6 -6
View File
@@ -20,7 +20,7 @@ const provider = new WsProvider('[http://127.0.0.1:9944')](http://127.0.0.1:9944
⊕ **new Api**(provider: *`ProviderInterface`*): [Api](_index_.api.md)
*Defined in [index.ts:29](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/index.ts#L29)*
*Defined in [index.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/index.ts#L29)*
*__constructor__*: Default constructor for the Api Object
@@ -42,7 +42,7 @@ ___
**● author**: *[ApiInterface$Section](../modules/_types_d_.md#apiinterface_section)*
*Defined in [index.ts:26](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/index.ts#L26)*
*Defined in [index.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/index.ts#L26)*
___
<a id="chain"></a>
@@ -51,7 +51,7 @@ ___
**● chain**: *[ApiInterface$Section](../modules/_types_d_.md#apiinterface_section)*
*Defined in [index.ts:27](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/index.ts#L27)*
*Defined in [index.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/index.ts#L27)*
___
<a id="state"></a>
@@ -60,7 +60,7 @@ ___
**● state**: *[ApiInterface$Section](../modules/_types_d_.md#apiinterface_section)*
*Defined in [index.ts:28](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/index.ts#L28)*
*Defined in [index.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/index.ts#L28)*
___
<a id="system"></a>
@@ -69,7 +69,7 @@ ___
**● system**: *[ApiInterface$Section](../modules/_types_d_.md#apiinterface_section)*
*Defined in [index.ts:29](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/index.ts#L29)*
*Defined in [index.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/index.ts#L29)*
___
@@ -81,7 +81,7 @@ ___
▸ **signature**(__namedParameters: *`object`*): `string`
*Defined in [index.ts:58](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/index.ts#L58)*
*Defined in [index.ts:58](https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/index.ts#L58)*
*__name__*: signature
docs/api/index.html
+1 -1
View File
@@ -461,7 +461,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"api","level":"1.2","depth":1,"next":{"title":"Api","level":"1.2.1","depth":2,"path":"api/classes/_index_.api.md","ref":"api/classes/_index_.api.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/README.md","mtime":"2018-10-02T09:13:06.838Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:13:59.444Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"api","level":"1.2","depth":1,"next":{"title":"Api","level":"1.2.1","depth":2,"path":"api/classes/_index_.api.md","ref":"api/classes/_index_.api.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api/README.md","mtime":"2018-10-02T09:33:24.446Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:34:30.873Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/api/interfaces/_types_d_.apiinterface_section_method.md
+3 -3
View File
@@ -7,7 +7,7 @@
# Callable
▸ **__call**(...params: *`Array`<`any`>*): `Promise`<`any`>
*Defined in [types.d.ts:7](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/types.d.ts#L7)*
*Defined in [types.d.ts:7](https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/types.d.ts#L7)*
**Parameters:**
@@ -25,7 +25,7 @@
**● subscription**: *`string`*
*Defined in [types.d.ts:10](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/types.d.ts#L10)*
*Defined in [types.d.ts:10](https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/types.d.ts#L10)*
___
<a id="unsubscribe"></a>
@@ -34,7 +34,7 @@ ___
**● unsubscribe**: *`function`*
*Defined in [types.d.ts:11](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/types.d.ts#L11)*
*Defined in [types.d.ts:11](https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/types.d.ts#L11)*
#### Type declaration
▸(id: *`number`*): `Promise`<`any`>
docs/api/modules/_types_d_.md
+2 -2
View File
@@ -8,7 +8,7 @@
**Ƭ ApiInterface**: *`object`*
*Defined in [types.d.ts:18](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/types.d.ts#L18)*
*Defined in [types.d.ts:18](https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/types.d.ts#L18)*
#### Type declaration
@@ -19,7 +19,7 @@ ___
**Ƭ ApiInterface$Section**: *`object`*
*Defined in [types.d.ts:14](https://github.com/polkadot-js/api/blob/2f60ba0/packages/api/src/types.d.ts#L14)*
*Defined in [types.d.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/api/src/types.d.ts#L14)*
#### Type declaration
docs/examples/01_simple_connect/index.html
+1 -1
View File
@@ -431,7 +431,7 @@ main().finally(_ =&gt; process.exit());
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Simple connect","level":"2.2","depth":1,"next":{"title":"Listen to blocks","level":"2.3","depth":1,"path":"examples/02_listen_to_blocks/README.md","ref":"examples/02_listen_to_blocks/README.md","articles":[]},"previous":{"title":"Overview","level":"2.1","depth":1,"path":"examples/README.md","ref":"examples/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/01_simple_connect/README.md","mtime":"2018-10-02T09:11:18.875Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:13:59.444Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Simple connect","level":"2.2","depth":1,"next":{"title":"Listen to blocks","level":"2.3","depth":1,"path":"examples/02_listen_to_blocks/README.md","ref":"examples/02_listen_to_blocks/README.md","articles":[]},"previous":{"title":"Overview","level":"2.1","depth":1,"path":"examples/README.md","ref":"examples/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/01_simple_connect/README.md","mtime":"2018-10-02T09:31:33.336Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:34:30.873Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/examples/02_listen_to_blocks/index.html
+1 -1
View File
@@ -433,7 +433,7 @@ main();
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Listen to blocks","level":"2.3","depth":1,"next":{"title":"Listen to balance change","level":"2.4","depth":1,"path":"examples/03_listen_to_balance_change/README.md","ref":"examples/03_listen_to_balance_change/README.md","articles":[]},"previous":{"title":"Simple connect","level":"2.2","depth":1,"path":"examples/01_simple_connect/README.md","ref":"examples/01_simple_connect/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/02_listen_to_blocks/README.md","mtime":"2018-10-02T09:11:18.879Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:13:59.444Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Listen to blocks","level":"2.3","depth":1,"next":{"title":"Listen to balance change","level":"2.4","depth":1,"path":"examples/03_listen_to_balance_change/README.md","ref":"examples/03_listen_to_balance_change/README.md","articles":[]},"previous":{"title":"Simple connect","level":"2.2","depth":1,"path":"examples/01_simple_connect/README.md","ref":"examples/01_simple_connect/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/02_listen_to_blocks/README.md","mtime":"2018-10-02T09:31:33.336Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:34:30.873Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/examples/03_listen_to_balance_change/index.html
+1 -1
View File
@@ -432,7 +432,7 @@ api.state
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Listen to balance change","level":"2.4","depth":1,"next":{"title":"Generate Accounts","level":"2.5","depth":1,"path":"examples/04_generate_account/README.md","ref":"examples/04_generate_account/README.md","articles":[]},"previous":{"title":"Listen to blocks","level":"2.3","depth":1,"path":"examples/02_listen_to_blocks/README.md","ref":"examples/02_listen_to_blocks/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/03_listen_to_balance_change/README.md","mtime":"2018-10-02T09:11:18.879Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:13:59.444Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Listen to balance change","level":"2.4","depth":1,"next":{"title":"Generate Accounts","level":"2.5","depth":1,"path":"examples/04_generate_account/README.md","ref":"examples/04_generate_account/README.md","articles":[]},"previous":{"title":"Listen to blocks","level":"2.3","depth":1,"path":"examples/02_listen_to_blocks/README.md","ref":"examples/02_listen_to_blocks/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/03_listen_to_balance_change/README.md","mtime":"2018-10-02T09:31:33.340Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:34:30.873Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/examples/04_generate_account/index.html
+1 -1
View File
@@ -447,7 +447,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Generate Accounts","level":"2.5","depth":1,"next":{"title":"Read Storage","level":"2.6","depth":1,"path":"examples/05_read_storage/README.md","ref":"examples/05_read_storage/README.md","articles":[]},"previous":{"title":"Listen to balance change","level":"2.4","depth":1,"path":"examples/03_listen_to_balance_change/README.md","ref":"examples/03_listen_to_balance_change/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/04_generate_account/README.md","mtime":"2018-10-02T09:11:18.879Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:13:59.444Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Generate Accounts","level":"2.5","depth":1,"next":{"title":"Read Storage","level":"2.6","depth":1,"path":"examples/05_read_storage/README.md","ref":"examples/05_read_storage/README.md","articles":[]},"previous":{"title":"Listen to balance change","level":"2.4","depth":1,"path":"examples/03_listen_to_balance_change/README.md","ref":"examples/03_listen_to_balance_change/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/04_generate_account/README.md","mtime":"2018-10-02T09:31:33.340Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:34:30.873Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/examples/05_read_storage/index.html
+1 -1
View File
@@ -447,7 +447,7 @@ main().finally(_ =&gt; process.exit());
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Read Storage","level":"2.6","depth":1,"next":{"title":"Craft Extrinsic","level":"2.7","depth":1,"path":"examples/06_craft_extrinsic/README.md","ref":"examples/06_craft_extrinsic/README.md","articles":[]},"previous":{"title":"Generate Accounts","level":"2.5","depth":1,"path":"examples/04_generate_account/README.md","ref":"examples/04_generate_account/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/05_read_storage/README.md","mtime":"2018-10-02T09:11:18.879Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:13:59.444Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Read Storage","level":"2.6","depth":1,"next":{"title":"Craft Extrinsic","level":"2.7","depth":1,"path":"examples/06_craft_extrinsic/README.md","ref":"examples/06_craft_extrinsic/README.md","articles":[]},"previous":{"title":"Generate Accounts","level":"2.5","depth":1,"path":"examples/04_generate_account/README.md","ref":"examples/04_generate_account/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/05_read_storage/README.md","mtime":"2018-10-02T09:31:33.340Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:34:30.873Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/examples/06_craft_extrinsic/index.html
+1 -1
View File
@@ -471,7 +471,7 @@ transfer(Alice, addressBob, amount)
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Craft Extrinsic","level":"2.7","depth":1,"next":{"title":"Transfer DOTs","level":"2.8","depth":1,"path":"examples/07_transfer_dots/README.md","ref":"examples/07_transfer_dots/README.md","articles":[]},"previous":{"title":"Read Storage","level":"2.6","depth":1,"path":"examples/05_read_storage/README.md","ref":"examples/05_read_storage/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/06_craft_extrinsic/README.md","mtime":"2018-10-02T09:11:18.879Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:13:59.444Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Craft Extrinsic","level":"2.7","depth":1,"next":{"title":"Transfer DOTs","level":"2.8","depth":1,"path":"examples/07_transfer_dots/README.md","ref":"examples/07_transfer_dots/README.md","articles":[]},"previous":{"title":"Read Storage","level":"2.6","depth":1,"path":"examples/05_read_storage/README.md","ref":"examples/05_read_storage/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/06_craft_extrinsic/README.md","mtime":"2018-10-02T09:31:33.340Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:34:30.873Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/examples/07_transfer_dots/index.html
+1 -1
View File
@@ -451,7 +451,7 @@ transfer(Alice, addressBob, amount)
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Transfer DOTs","level":"2.8","depth":1,"previous":{"title":"Craft Extrinsic","level":"2.7","depth":1,"path":"examples/06_craft_extrinsic/README.md","ref":"examples/06_craft_extrinsic/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/07_transfer_dots/README.md","mtime":"2018-10-02T09:11:18.879Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:13:59.444Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Transfer DOTs","level":"2.8","depth":1,"previous":{"title":"Craft Extrinsic","level":"2.7","depth":1,"path":"examples/06_craft_extrinsic/README.md","ref":"examples/06_craft_extrinsic/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/07_transfer_dots/README.md","mtime":"2018-10-02T09:31:33.340Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:34:30.873Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/examples/index.html
+1 -1
View File
@@ -427,7 +427,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Overview","level":"2.1","depth":1,"next":{"title":"Simple connect","level":"2.2","depth":1,"path":"examples/01_simple_connect/README.md","ref":"examples/01_simple_connect/README.md","articles":[]},"previous":{"title":"ApiRx","level":"1.4.1","depth":2,"path":"api-rx/classes/_index_.rxapi.md","ref":"api-rx/classes/_index_.rxapi.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/README.md","mtime":"2018-10-02T09:11:18.879Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:13:59.444Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Overview","level":"2.1","depth":1,"next":{"title":"Simple connect","level":"2.2","depth":1,"path":"examples/01_simple_connect/README.md","ref":"examples/01_simple_connect/README.md","articles":[]},"previous":{"title":"ApiRx","level":"1.4.1","depth":2,"path":"api-rx/classes/_index_.rxapi.md","ref":"api-rx/classes/_index_.rxapi.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/README.md","mtime":"2018-10-02T09:31:33.340Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:34:30.873Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/index.html
+1 -1
View File
@@ -447,7 +447,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"api","level":"1.2","depth":1,"path":"api/README.md","ref":"api/README.md","articles":[{"title":"Api","level":"1.2.1","depth":2,"path":"api/classes/_index_.api.md","ref":"api/classes/_index_.api.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"README.md","mtime":"2018-10-02T09:11:18.875Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:13:59.444Z"},"basePath":".","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"api","level":"1.2","depth":1,"path":"api/README.md","ref":"api/README.md","articles":[{"title":"Api","level":"1.2.1","depth":2,"path":"api/classes/_index_.api.md","ref":"api/classes/_index_.api.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"README.md","mtime":"2018-10-02T09:31:33.332Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-02T09:34:30.873Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
docs/types/README.md
+6
View File
@@ -0,0 +1,6 @@
@polkadot/types
===============
Implementation of the types and their serialisation via parity-codec
docs/types/SUMMARY.md
+151
View File
@@ -0,0 +1,151 @@
* [&quot;AccountId&quot;](modules/_accountid_.md)
* [AccountId](classes/_accountid_.accountid.md)
* [&quot;AccountIndex&quot;](modules/_accountindex_.md)
* [AccountIndex](classes/_accountindex_.accountindex.md)
* [&quot;Address&quot;](modules/_address_.md)
* [Address](classes/_address_.address.md)
* [&quot;AuthorityId&quot;](modules/_authorityid_.md)
* [AuthorityId](classes/_authorityid_.authorityid.md)
* [&quot;Balance&quot;](modules/_balance_.md)
* [Balance](classes/_balance_.balance.md)
* [&quot;Bft&quot;](modules/_bft_.md)
* [BftAuthoritySignature](classes/_bft_.bftauthoritysignature.md)
* [BftHashSignature](classes/_bft_.bfthashsignature.md)
* [Justification](classes/_bft_.justification.md)
* [&quot;Block&quot;](modules/_block_.md)
* [Block](classes/_block_.block.md)
* [&quot;BlockNumber&quot;](modules/_blocknumber_.md)
* [BlockNumber](classes/_blocknumber_.blocknumber.md)
* [&quot;Bool&quot;](modules/_bool_.md)
* [Bool](classes/_bool_.bool.md)
* [&quot;Bytes&quot;](modules/_bytes_.md)
* [Bytes](classes/_bytes_.bytes.md)
* [&quot;Extrinsic&quot;](modules/_extrinsic_.md)
* [Extrinsic](classes/_extrinsic_.extrinsic.md)
* [&quot;Extrinsics&quot;](modules/_extrinsics_.md)
* [Extrinsics](classes/_extrinsics_.extrinsics.md)
* [&quot;Gas&quot;](modules/_gas_.md)
* [Gas](classes/_gas_.gas.md)
* [&quot;H256&quot;](modules/_h256_.md)
* [H256](classes/_h256_.h256.md)
* [&quot;H512&quot;](modules/_h512_.md)
* [H512](classes/_h512_.h512.md)
* [&quot;Hash&quot;](modules/_hash_.md)
* [Hash](classes/_hash_.hash.md)
* [&quot;Header&quot;](modules/_header_.md)
* [Digest](classes/_header_.digest.md)
* [Header](classes/_header_.header.md)
* [&quot;KeyValue&quot;](modules/_keyvalue_.md)
* [KeyValue](classes/_keyvalue_.keyvalue.md)
* [KeyValueOption](classes/_keyvalue_.keyvalueoption.md)
* [&quot;Metadata&quot;](modules/_metadata_.md)
* [CallMetadata](classes/_metadata_.callmetadata.md)
* [EventMetadata](classes/_metadata_.eventmetadata.md)
* [FunctionArgumentMetadata](classes/_metadata_.functionargumentmetadata.md)
* [FunctionMetadata](classes/_metadata_.functionmetadata.md)
* [ModuleMetadata](classes/_metadata_.modulemetadata.md)
* [OuterEventMetadata](classes/_metadata_.outereventmetadata.md)
* [OuterEventMetadataEvent](classes/_metadata_.outereventmetadataevent.md)
* [RuntimeMetadata](classes/_metadata_.runtimemetadata.md)
* [RuntimeModuleMetadata](classes/_metadata_.runtimemodulemetadata.md)
* [StorageFunctionMetadata](classes/_metadata_.storagefunctionmetadata.md)
* [StorageFunctionModifier](classes/_metadata_.storagefunctionmodifier.md)
* [StorageFunctionType](classes/_metadata_.storagefunctiontype.md)
* [StorageFunctionType$Map](classes/_metadata_.storagefunctiontype_map.md)
* [StorageMetadata](classes/_metadata_.storagemetadata.md)
* [&quot;Metadata.rpc&quot;](modules/_metadata_rpc_.md)
* [&quot;MisbehaviorReport&quot;](modules/_misbehaviorreport_.md)
* [BftAtReport](classes/_misbehaviorreport_.bftatreport.md)
* [BftDoubleCommit](classes/_misbehaviorreport_.bftdoublecommit.md)
* [BftDoublePrepare](classes/_misbehaviorreport_.bftdoubleprepare.md)
* [MisbehaviorKind](classes/_misbehaviorreport_.misbehaviorkind.md)
* [MisbehaviorReport](classes/_misbehaviorreport_.misbehaviorreport.md)
* [&quot;Moment&quot;](modules/_moment_.md)
* [Moment](classes/_moment_.moment.md)
* [&quot;NewAccountOutcome&quot;](modules/_newaccountoutcome_.md)
* [NewAccountOutcome](classes/_newaccountoutcome_.newaccountoutcome.md)
* [&quot;Nonce&quot;](modules/_nonce_.md)
* [Index](classes/_nonce_.index.md)
* [&quot;Origin&quot;](modules/_origin_.md)
* [Origin](classes/_origin_.origin.md)
* [&quot;ParachainId&quot;](modules/_parachainid_.md)
* [ParachainId](classes/_parachainid_.parachainid.md)
* [&quot;PendingExtrinsics&quot;](modules/_pendingextrinsics_.md)
* [PendingExtrinsics](classes/_pendingextrinsics_.pendingextrinsics.md)
* [&quot;Perbill&quot;](modules/_perbill_.md)
* [Perbill](classes/_perbill_.perbill.md)
* [&quot;Permill&quot;](modules/_permill_.md)
* [Permill](classes/_permill_.permill.md)
* [&quot;PropIndex&quot;](modules/_propindex_.md)
* [PropIndex](classes/_propindex_.propindex.md)
* [&quot;Proposal&quot;](modules/_proposal_.md)
* [Proposal](classes/_proposal_.proposal.md)
* [&quot;ProposalIndex&quot;](modules/_proposalindex_.md)
* [ProposalIndex](classes/_proposalindex_.proposalindex.md)
* [&quot;RawAddress&quot;](modules/_rawaddress_.md)
* [RawAddress](classes/_rawaddress_.rawaddress.md)
* [&quot;ReferendumIndex&quot;](modules/_referendumindex_.md)
* [ReferendumIndex](classes/_referendumindex_.referendumindex.md)
* [&quot;RuntimeVersion&quot;](modules/_runtimeversion_.md)
* [RuntimeVersion](classes/_runtimeversion_.runtimeversion.md)
* [&quot;Signature&quot;](modules/_signature_.md)
* [Signature](classes/_signature_.signature.md)
* [&quot;SignedBlock&quot;](modules/_signedblock_.md)
* [SignedBlock](classes/_signedblock_.signedblock.md)
* [&quot;StorageChangeSet&quot;](modules/_storagechangeset_.md)
* [StorageChangeSet](classes/_storagechangeset_.storagechangeset.md)
* [&quot;StorageData&quot;](modules/_storagedata_.md)
* [StorageData](classes/_storagedata_.storagedata.md)
* [&quot;StorageKey&quot;](modules/_storagekey_.md)
* [StorageKey](classes/_storagekey_.storagekey.md)
* [StorageFunction](interfaces/_storagekey_.storagefunction.md)
* [&quot;Text&quot;](modules/_text_.md)
* [Text](classes/_text_.text.md)
* [&quot;Type&quot;](modules/_type_.md)
* [Type](classes/_type_.type.md)
* [&quot;U128&quot;](modules/_u128_.md)
* [U128](classes/_u128_.u128.md)
* [&quot;U16&quot;](modules/_u16_.md)
* [U16](classes/_u16_.u16.md)
* [&quot;U256&quot;](modules/_u256_.md)
* [U256](classes/_u256_.u256.md)
* [&quot;U32&quot;](modules/_u32_.md)
* [U32](classes/_u32_.u32.md)
* [&quot;U64&quot;](modules/_u64_.md)
* [U64](classes/_u64_.u64.md)
* [&quot;U8&quot;](modules/_u8_.md)
* [U8](classes/_u8_.u8.md)
* [&quot;ValidatorPrefs&quot;](modules/_validatorprefs_.md)
* [ValidatorPrefs](classes/_validatorprefs_.validatorprefs.md)
* [&quot;VoteIndex&quot;](modules/_voteindex_.md)
* [VoteIndex](classes/_voteindex_.voteindex.md)
* [&quot;VoteThreshold&quot;](modules/_votethreshold_.md)
* [VoteThreshold](classes/_votethreshold_.votethreshold.md)
* [&quot;codec/Base&quot;](modules/_codec_base_.md)
* [Base](classes/_codec_base_.base.md)
* [&quot;codec/Compact&quot;](modules/_codec_compact_.md)
* [Compact](classes/_codec_compact_.compact.md)
* [&quot;codec/Enum&quot;](modules/_codec_enum_.md)
* [Enum](classes/_codec_enum_.enum.md)
* [&quot;codec/EnumType&quot;](modules/_codec_enumtype_.md)
* [EnumType](classes/_codec_enumtype_.enumtype.md)
* [&quot;codec/Length&quot;](modules/_codec_length_.md)
* [Length](classes/_codec_length_.length.md)
* [&quot;codec/Option&quot;](modules/_codec_option_.md)
* [Option](classes/_codec_option_.option.md)
* [&quot;codec/Struct&quot;](modules/_codec_struct_.md)
* [Struct](classes/_codec_struct_.struct.md)
* [&quot;codec/Tuple&quot;](modules/_codec_tuple_.md)
* [Tuple](classes/_codec_tuple_.tuple.md)
* [&quot;codec/U8a&quot;](modules/_codec_u8a_.md)
* [U8a](classes/_codec_u8a_.u8a.md)
* [&quot;codec/U8aFixed&quot;](modules/_codec_u8afixed_.md)
* [U8aFixed](classes/_codec_u8afixed_.u8afixed.md)
* [&quot;codec/UInt&quot;](modules/_codec_uint_.md)
* [UInt](classes/_codec_uint_.uint.md)
* [&quot;codec/Vector&quot;](modules/_codec_vector_.md)
* [Vector](classes/_codec_vector_.vector.md)
* [&quot;codec/createType&quot;](modules/_codec_createtype_.md)
* [&quot;codec/index&quot;](modules/_codec_index_.md)
* [&quot;index&quot;](modules/_index_.md)
* [&quot;types.d&quot;](modules/_types_d_.md)
docs/types/classes/_accountid_.accountid.md
+223
View File
@@ -0,0 +1,223 @@
# Hierarchy
↳ [U8aFixed](_codec_u8afixed_.u8afixed.md)
**↳ AccountId**
↳ [AuthorityId](_authorityid_.authorityid.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new AccountId**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [AccountId](_accountid_.accountid.md)
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [AccountId.ts:20](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L20)*
**Parameters:**
| Param | Type | Default value |
| ------ | ------ | ------ |
| `Default value` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | new Uint8Array() |
**Returns:** [AccountId](_accountid_.accountid.md)
___
# Properties
<a id="_bitlength"></a>
## `<Protected>` _bitLength
**● _bitLength**: *`number`*
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[_bitLength](_codec_u8afixed_.u8afixed.md#_bitlength)*
*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L14)*
___
<a id="raw"></a>
## raw
**● raw**: *`Uint8Array`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="length"></a>
## length
getlength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)*
*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L25)*
**Returns:** `number`
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[byteLength](_codec_u8afixed_.u8afixed.md#bytelength)*
*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)*
*Defined in [codec/U8aFixed.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L28)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [AccountId](_accountid_.accountid.md)
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromJSON](_codec_u8afixed_.u8afixed.md#fromjson)*
*Defined in [AccountId.ts:44](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L44)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [AccountId](_accountid_.accountid.md)
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [AccountId](_accountid_.accountid.md)
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromU8a](_codec_u8afixed_.u8afixed.md#fromu8a)*
*Defined in [AccountId.ts:50](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L50)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [AccountId](_accountid_.accountid.md)
___
<a id="tohex"></a>
## toHex
▸ **toHex**(): `string`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)*
**Returns:** `string`
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [AccountId.ts:56](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L56)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L60)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L53)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**(value: * `string` &#124; `Uint8Array` &#124; `Array`<`number`>*): `Uint8Array`
*Defined in [AccountId.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L34)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| value | `string` &#124; `Uint8Array` &#124; `Array`<`number`>|
**Returns:** `Uint8Array`
___
<a id="encode"></a>
## `<Static>` encode
▸ **encode**(value: *`Uint8Array`*): `string`
*Defined in [AccountId.ts:30](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L30)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| value | `Uint8Array` |
**Returns:** `string`
___
docs/types/classes/_accountindex_.accountindex.md
+210
View File
@@ -0,0 +1,210 @@
# Hierarchy
↳ [U8a](_codec_u8a_.u8a.md)
**↳ AccountIndex**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new AccountIndex**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [AccountIndex](_accountindex_.accountindex.md)
*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)*
*Defined in [AccountIndex.ts:15](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountIndex.ts#L15)*
**Parameters:**
| Param | Type | Default value |
| ------ | ------ | ------ |
| `Default value` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | new Uint8Array() |
**Returns:** [AccountIndex](_accountindex_.accountindex.md)
___
# Properties
<a id="raw"></a>
## raw
**● raw**: *`Uint8Array`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="length"></a>
## length
getlength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)*
*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L25)*
**Returns:** `number`
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/U8a.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L29)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [AccountIndex](_accountindex_.accountindex.md)
*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)*
*Defined in [AccountIndex.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountIndex.ts#L34)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [AccountIndex](_accountindex_.accountindex.md)
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [AccountIndex](_accountindex_.accountindex.md)
*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)*
*Defined in [AccountIndex.ts:43](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountIndex.ts#L43)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [AccountIndex](_accountindex_.accountindex.md)
___
<a id="tohex"></a>
## toHex
▸ **toHex**(): `string`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)*
**Returns:** `string`
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [AccountIndex.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountIndex.ts#L49)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
*Defined in [AccountIndex.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountIndex.ts#L53)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L53)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**(value: * `string` &#124; `Uint8Array` &#124; `Array`<`number`>*): `Uint8Array`
*Defined in [AccountIndex.ts:30](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountIndex.ts#L30)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| value | `string` &#124; `Uint8Array` &#124; `Array`<`number`>|
**Returns:** `Uint8Array`
___
<a id="encode"></a>
## `<Static>` encode
▸ **encode**(value: *`Uint8Array`*): `string`
*Defined in [AccountIndex.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountIndex.ts#L26)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| value | `Uint8Array` |
**Returns:** `string`
___
docs/types/classes/_address_.address.md
+197
View File
@@ -0,0 +1,197 @@
# Hierarchy
[Base](_codec_base_.base.md)< [AccountId](_accountid_.accountid.md) &#124; [AccountIndex](_accountindex_.accountindex.md)>
**↳ Address**
↳ [RawAddress](_rawaddress_.rawaddress.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new Address**(value?: * [Address](_address_.address.md) &#124; [AccountId](_accountid_.accountid.md) &#124; [AccountIndex](_accountindex_.accountindex.md) &#124; `string` &#124; `Uint8Array`*): [Address](_address_.address.md)
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [Address.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L19)*
**Parameters:**
| Param | Type | Default value |
| ------ | ------ | ------ |
| `Default value` value | [Address](_address_.address.md) &#124; [AccountId](_accountid_.accountid.md) &#124; [AccountIndex](_accountindex_.accountindex.md) &#124; `string` &#124; `Uint8Array`| new Uint8Array() |
**Returns:** [Address](_address_.address.md)
___
# Properties
<a id="raw"></a>
## raw
**● raw**: * [AccountId](_accountid_.accountid.md) &#124; [AccountIndex](_accountindex_.accountindex.md)
*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [Address.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L86)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Address](_address_.address.md)
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L90)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Address](_address_.address.md)
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Address](_address_.address.md)
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [Address.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Address](_address_.address.md)
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [Address.ts:109](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L109)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [Address.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L113)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [Address.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L117)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**(value: * [AccountId](_accountid_.accountid.md) &#124; [AccountIndex](_accountindex_.accountindex.md) &#124; `string` &#124; `Uint8Array` &#124; `Array`<`number`>*): [AccountId](_accountid_.accountid.md) &#124; [AccountIndex](_accountindex_.accountindex.md)
*Defined in [Address.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L28)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| value | [AccountId](_accountid_.accountid.md) &#124; [AccountIndex](_accountindex_.accountindex.md) &#124; `string` &#124; `Uint8Array` &#124; `Array`<`number`>|
**Returns:** [AccountId](_accountid_.accountid.md) &#124; [AccountIndex](_accountindex_.accountindex.md)
___
<a id="readlength"></a>
## `<Static>` readLength
▸ **readLength**(input: *`Uint8Array`*): `number`
*Defined in [Address.ts:52](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L52)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** `number`
___
<a id="writelength"></a>
## `<Static>` writeLength
▸ **writeLength**(length: *`number`*): `Uint8Array`
*Defined in [Address.ts:70](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Address.ts#L70)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| length | `number` |
**Returns:** `Uint8Array`
___
docs/types/classes/_authorityid_.authorityid.md
+235
View File
@@ -0,0 +1,235 @@
# Hierarchy
↳ [AccountId](_accountid_.accountid.md)
**↳ AuthorityId**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new AuthorityId**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [AuthorityId](_authorityid_.authorityid.md)
*Inherited from [AccountId](_accountid_.accountid.md).[constructor](_accountid_.accountid.md#constructor)*
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [AccountId.ts:20](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L20)*
**Parameters:**
| Param | Type | Default value |
| ------ | ------ | ------ |
| `Default value` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | new Uint8Array() |
**Returns:** [AuthorityId](_authorityid_.authorityid.md)
___
# Properties
<a id="_bitlength"></a>
## `<Protected>` _bitLength
**● _bitLength**: *`number`*
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[_bitLength](_codec_u8afixed_.u8afixed.md#_bitlength)*
*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L14)*
___
<a id="raw"></a>
## raw
**● raw**: *`Uint8Array`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="length"></a>
## length
getlength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)*
*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L25)*
**Returns:** `number`
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[byteLength](_codec_u8afixed_.u8afixed.md#bytelength)*
*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)*
*Defined in [codec/U8aFixed.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L28)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [AccountId](_accountid_.accountid.md)
*Inherited from [AccountId](_accountid_.accountid.md).[fromJSON](_accountid_.accountid.md#fromjson)*
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromJSON](_codec_u8afixed_.u8afixed.md#fromjson)*
*Defined in [AccountId.ts:44](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L44)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [AccountId](_accountid_.accountid.md)
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [AccountId](_accountid_.accountid.md)
*Inherited from [AccountId](_accountid_.accountid.md).[fromU8a](_accountid_.accountid.md#fromu8a)*
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromU8a](_codec_u8afixed_.u8afixed.md#fromu8a)*
*Defined in [AccountId.ts:50](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L50)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [AccountId](_accountid_.accountid.md)
___
<a id="tohex"></a>
## toHex
▸ **toHex**(): `string`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)*
**Returns:** `string`
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [AccountId](_accountid_.accountid.md).[toJSON](_accountid_.accountid.md#tojson)*
*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [AccountId.ts:56](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L56)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [AccountId](_accountid_.accountid.md).[toString](_accountid_.accountid.md#tostring)*
*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L60)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L53)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**(value: * `string` &#124; `Uint8Array` &#124; `Array`<`number`>*): `Uint8Array`
*Inherited from [AccountId](_accountid_.accountid.md).[decode](_accountid_.accountid.md#decode)*
*Defined in [AccountId.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L34)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| value | `string` &#124; `Uint8Array` &#124; `Array`<`number`>|
**Returns:** `Uint8Array`
___
<a id="encode"></a>
## `<Static>` encode
▸ **encode**(value: *`Uint8Array`*): `string`
*Inherited from [AccountId](_accountid_.accountid.md).[encode](_accountid_.accountid.md#encode)*
*Defined in [AccountId.ts:30](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/AccountId.ts#L30)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| value | `Uint8Array` |
**Returns:** `string`
___
docs/types/classes/_balance_.balance.md
+399
View File
@@ -0,0 +1,399 @@
# Hierarchy
↳ [U128](_u128_.u128.md)
**↳ Balance**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new Balance**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [Balance](_balance_.balance.md)
*Inherited from [U128](_u128_.u128.md).[constructor](_u128_.u128.md#constructor)*
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
*Defined in [U128.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/U128.ts#L9)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) |
**Returns:** [Balance](_balance_.balance.md)
___
# Properties
<a id="raw"></a>
## raw
**● raw**: *`BN`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Methods
<a id="add"></a>
## add
▸ **add**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `BN`
*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L95)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| other | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `BN`
___
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L53)*
**Returns:** `number`
___
<a id="cmp"></a>
## cmp
▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `number`
*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| other | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `number`
___
<a id="div"></a>
## div
▸ **div**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `BN`
*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L107)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| other | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `BN`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md)
*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)*
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L57)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [UInt](_codec_uint_.uint.md)
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md)
*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L63)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [UInt](_codec_uint_.uint.md)
___
<a id="gt"></a>
## gt
▸ **gt**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| test | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `boolean`
___
<a id="gte"></a>
## gte
▸ **gte**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| test | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `boolean`
___
<a id="iszero"></a>
## isZero
▸ **isZero**(): `boolean`
*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L113)*
**Returns:** `boolean`
___
<a id="lt"></a>
## lt
▸ **lt**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)*
*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L117)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| test | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `boolean`
___
<a id="lte"></a>
## lte
▸ **lte**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)*
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L123)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| test | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `boolean`
___
<a id="mul"></a>
## mul
▸ **mul**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `BN`
*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| other | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `BN`
___
<a id="sub"></a>
## sub
▸ **sub**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `BN`
*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| other | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `BN`
___
<a id="tobn"></a>
## toBn
▸ **toBn**(): `BN`
*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L85)*
**Returns:** `BN`
___
<a id="tohex"></a>
## toHex
▸ **toHex**(): `string`
*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L69)*
**Returns:** `string`
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `any`
___
<a id="tonumber"></a>
## toNumber
▸ **toNumber**(): `number`
*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)*
*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L89)*
**Returns:** `number`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L81)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L77)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN`
*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)*
*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L38)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| value | [AnyNumber](../modules/_types_d_.md#anynumber) |
**Returns:** `BN`
___
docs/types/classes/_bft_.bftauthoritysignature.md
+315
View File
@@ -0,0 +1,315 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
↳ [Tuple](_codec_tuple_.tuple.md)
**↳ BftAuthoritySignature**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new BftAuthoritySignature**(value?: *[BftAuthoritySignatureValue](../modules/_bft_.md#bftauthoritysignaturevalue)*): [BftAuthoritySignature](_bft_.bftauthoritysignature.md)
*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [Bft.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bft.ts#L22)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | [BftAuthoritySignatureValue](../modules/_bft_.md#bftauthoritysignaturevalue) |
**Returns:** [BftAuthoritySignature](_bft_.bftauthoritysignature.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)*
*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="authorityid"></a>
## authorityId
getauthorityId(): [AuthorityId](_authorityid_.authorityid.md)
*Defined in [Bft.ts:30](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bft.ts#L30)*
**Returns:** [AuthorityId](_authorityid_.authorityid.md)
___
<a id="signature"></a>
## signature
getsignature(): [Signature](_signature_.signature.md)
*Defined in [Bft.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bft.ts#L34)*
**Returns:** [Signature](_signature_.signature.md)
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`>
*Inherited from [Tuple](_codec_tuple_.tuple.md).[fromJSON](_codec_tuple_.tuple.md#fromjson)*
*Overrides [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Defined in [codec/Tuple.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L34)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** [Base](_codec_base_.base.md)
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Tuple.ts:46](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L46)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)*
*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
*Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Tuple.ts:24](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L24)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/types/classes/_bft_.bfthashsignature.md
+315
View File
@@ -0,0 +1,315 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
↳ [Tuple](_codec_tuple_.tuple.md)
**↳ BftHashSignature**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new BftHashSignature**(value?: *[BftHashSignatureValue](../modules/_bft_.md#bfthashsignaturevalue)*): [BftHashSignature](_bft_.bfthashsignature.md)
*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [Bft.ts:46](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bft.ts#L46)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | [BftHashSignatureValue](../modules/_bft_.md#bfthashsignaturevalue) |
**Returns:** [BftHashSignature](_bft_.bfthashsignature.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)*
*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="hash"></a>
## hash
gethash(): [Hash](_hash_.hash.md)
*Defined in [Bft.ts:54](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bft.ts#L54)*
**Returns:** [Hash](_hash_.hash.md)
___
<a id="signature"></a>
## signature
getsignature(): [Signature](_signature_.signature.md)
*Defined in [Bft.ts:58](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bft.ts#L58)*
**Returns:** [Signature](_signature_.signature.md)
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`>
*Inherited from [Tuple](_codec_tuple_.tuple.md).[fromJSON](_codec_tuple_.tuple.md#fromjson)*
*Overrides [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Defined in [codec/Tuple.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L34)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** [Base](_codec_base_.base.md)
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Tuple.ts:46](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L46)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)*
*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
*Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Tuple.ts:24](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L24)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/types/classes/_bft_.justification.md
+324
View File
@@ -0,0 +1,324 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
↳ [Struct](_codec_struct_.struct.md)
**↳ Justification**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new Justification**(value?: *[JustificationValue](../modules/_bft_.md#justificationvalue)*): [Justification](_bft_.justification.md)
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Bft.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bft.ts#L69)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | [JustificationValue](../modules/_bft_.md#justificationvalue) |
**Returns:** [Justification](_bft_.justification.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)*
*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="hash"></a>
## hash
gethash(): [Hash](_hash_.hash.md)
*Defined in [Bft.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bft.ts#L80)*
**Returns:** [Hash](_hash_.hash.md)
___
<a id="round"></a>
## round
getround(): [U32](_u32_.u32.md)
*Defined in [Bft.ts:84](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bft.ts#L84)*
**Returns:** [U32](_u32_.u32.md)
___
<a id="signatures"></a>
## signatures
getsignatures(): [Vector](_codec_vector_.vector.md)<[BftAuthoritySignature](_bft_.bftauthoritysignature.md)>
*Defined in [Bft.ts:88](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bft.ts#L88)*
**Returns:** [Vector](_codec_vector_.vector.md)<[BftAuthoritySignature](_bft_.bftauthoritysignature.md)>
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** [Base](_codec_base_.base.md)
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)*
*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/types/classes/_block_.block.md
+324
View File
@@ -0,0 +1,324 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
↳ [Struct](_codec_struct_.struct.md)
**↳ Block**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new Block**(value?: *[BlockValue](../modules/_block_.md#blockvalue)*): [Block](_block_.block.md)
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Block.ts:20](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Block.ts#L20)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | [BlockValue](../modules/_block_.md#blockvalue) |
**Returns:** [Block](_block_.block.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)*
*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="extrinsics"></a>
## extrinsics
getextrinsics(): [Extrinsics](_extrinsics_.extrinsics.md)
*Defined in [Block.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Block.ts#L28)*
**Returns:** [Extrinsics](_extrinsics_.extrinsics.md)
___
<a id="hash"></a>
## hash
gethash(): [Hash](_hash_.hash.md)
*Defined in [Block.ts:33](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Block.ts#L33)*
**Returns:** [Hash](_hash_.hash.md)
___
<a id="header"></a>
## header
getheader(): [Header](_header_.header.md)
*Defined in [Block.ts:39](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Block.ts#L39)*
**Returns:** [Header](_header_.header.md)
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** [Base](_codec_base_.base.md)
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)*
*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/types/classes/_blocknumber_.blocknumber.md
+399
View File
@@ -0,0 +1,399 @@
# Hierarchy
↳ [U64](_u64_.u64.md)
**↳ BlockNumber**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new BlockNumber**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [BlockNumber](_blocknumber_.blocknumber.md)
*Inherited from [U64](_u64_.u64.md).[constructor](_u64_.u64.md#constructor)*
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/U64.ts#L9)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) |
**Returns:** [BlockNumber](_blocknumber_.blocknumber.md)
___
# Properties
<a id="raw"></a>
## raw
**● raw**: *`BN`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Methods
<a id="add"></a>
## add
▸ **add**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `BN`
*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L95)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| other | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `BN`
___
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L53)*
**Returns:** `number`
___
<a id="cmp"></a>
## cmp
▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `number`
*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| other | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `number`
___
<a id="div"></a>
## div
▸ **div**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `BN`
*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L107)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| other | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `BN`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md)
*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)*
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L57)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [UInt](_codec_uint_.uint.md)
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md)
*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L63)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [UInt](_codec_uint_.uint.md)
___
<a id="gt"></a>
## gt
▸ **gt**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| test | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `boolean`
___
<a id="gte"></a>
## gte
▸ **gte**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| test | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `boolean`
___
<a id="iszero"></a>
## isZero
▸ **isZero**(): `boolean`
*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L113)*
**Returns:** `boolean`
___
<a id="lt"></a>
## lt
▸ **lt**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)*
*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L117)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| test | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `boolean`
___
<a id="lte"></a>
## lte
▸ **lte**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)*
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L123)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| test | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `boolean`
___
<a id="mul"></a>
## mul
▸ **mul**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `BN`
*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| other | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `BN`
___
<a id="sub"></a>
## sub
▸ **sub**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `BN`
*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| other | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `BN`
___
<a id="tobn"></a>
## toBn
▸ **toBn**(): `BN`
*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L85)*
**Returns:** `BN`
___
<a id="tohex"></a>
## toHex
▸ **toHex**(): `string`
*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L69)*
**Returns:** `string`
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `any`
___
<a id="tonumber"></a>
## toNumber
▸ **toNumber**(): `number`
*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)*
*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L89)*
**Returns:** `number`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L81)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L77)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN`
*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)*
*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L38)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| value | [AnyNumber](../modules/_types_d_.md#anynumber) |
**Returns:** `BN`
___
docs/types/classes/_bool_.bool.md
+143
View File
@@ -0,0 +1,143 @@
# Hierarchy
[Base](_codec_base_.base.md)<`boolean`>
**↳ Bool**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new Bool**(value?: * [Bool](_bool_.bool.md) &#124; `boolean`*): [Bool](_bool_.bool.md)
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [Bool.ts:7](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bool.ts#L7)*
**Parameters:**
| Param | Type | Default value |
| ------ | ------ | ------ |
| `Default value` value | [Bool](_bool_.bool.md) &#124; `boolean`| false |
**Returns:** [Bool](_bool_.bool.md)
___
# Properties
<a id="raw"></a>
## raw
**● raw**: *`boolean`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [Bool.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bool.ts#L16)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Bool](_bool_.bool.md)
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [Bool.ts:20](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bool.ts#L20)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Bool](_bool_.bool.md)
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Bool](_bool_.bool.md)
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [Bool.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bool.ts#L26)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Bool](_bool_.bool.md)
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [Bool.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bool.ts#L32)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [Bool.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bool.ts#L40)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [Bool.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bool.ts#L36)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
docs/types/classes/_bytes_.bytes.md
+191
View File
@@ -0,0 +1,191 @@
# Hierarchy
↳ [U8a](_codec_u8a_.u8a.md)
**↳ Bytes**
↳ [Extrinsic](_extrinsic_.extrinsic.md)
↳ [StorageData](_storagedata_.storagedata.md)
↳ [StorageKey](_storagekey_.storagekey.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new Bytes**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [Bytes](_bytes_.bytes.md)
*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)*
*Defined in [Bytes.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L16)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | [AnyU8a](../modules/_types_d_.md#anyu8a) |
**Returns:** [Bytes](_bytes_.bytes.md)
___
# Properties
<a id="_length"></a>
## `<Protected>` _length
**● _length**: *[Length](_codec_length_.length.md)*
*Defined in [Bytes.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L16)*
___
<a id="raw"></a>
## raw
**● raw**: *`Uint8Array`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="length"></a>
## length
getlength(): `number`
*Overrides [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)*
*Defined in [Bytes.ts:24](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L24)*
**Returns:** `number`
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)*
*Defined in [Bytes.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L28)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Bytes](_bytes_.bytes.md)
*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)*
*Defined in [Bytes.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L32)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Bytes](_bytes_.bytes.md)
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Bytes](_bytes_.bytes.md)
*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)*
*Defined in [Bytes.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L40)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Bytes](_bytes_.bytes.md)
___
<a id="tohex"></a>
## toHex
▸ **toHex**(): `string`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)*
**Returns:** `string`
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L49)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L57)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [Bytes.ts:51](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L51)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
docs/types/classes/_codec_base_.base.md
+153
View File
@@ -0,0 +1,153 @@
# Type parameters
#### T
# Hierarchy
**Base**
↳ [U8a](_codec_u8a_.u8a.md)
↳ [Address](_address_.address.md)
↳ [UInt](_codec_uint_.uint.md)
↳ [Struct](_codec_struct_.struct.md)
↳ [Length](_codec_length_.length.md)
↳ [Vector](_codec_vector_.vector.md)
↳ [Bool](_bool_.bool.md)
↳ [Option](_codec_option_.option.md)
↳ [Enum](_codec_enum_.enum.md)
↳ [EnumType](_codec_enumtype_.enumtype.md)
↳ [Text](_text_.text.md)
↳ [Moment](_moment_.moment.md)
↳ [Origin](_origin_.origin.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new Base**(value?: *`any`*): [Base](_codec_base_.base.md)
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | `any` |
**Returns:** [Base](_codec_base_.base.md)
___
# Properties
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Defined in [codec/Base.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L25)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Base](_codec_base_.base.md)<`T`>
*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L29)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Base](_codec_base_.base.md)<`T`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Base](_codec_base_.base.md)<`T`>
*Defined in [codec/Base.ts:33](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L33)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Base](_codec_base_.base.md)<`T`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Defined in [codec/Base.ts:37](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L37)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Defined in [codec/Base.ts:41](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L41)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Defined in [codec/Base.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L45)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
docs/types/classes/_codec_compact_.compact.md
+45
View File
@@ -0,0 +1,45 @@
# Hierarchy
**Compact**
# Methods
<a id="decode"></a>
## `<Static>` decode
▸ **decode**(input: *`Uint8Array`*, bitLength: *`BitLength`*): `BN`
*Defined in [codec/Compact.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Compact.ts#L32)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
| bitLength | `BitLength` |
**Returns:** `BN`
___
<a id="encode"></a>
## `<Static>` encode
▸ **encode**(length: *`BN`*, bitLength: *`BitLength`*): `Uint8Array`
*Defined in [codec/Compact.ts:48](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Compact.ts#L48)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| length | `BN` |
| bitLength | `BitLength` |
**Returns:** `Uint8Array`
___
docs/types/classes/_codec_enum_.enum.md
+161
View File
@@ -0,0 +1,161 @@
# Hierarchy
[Base](_codec_base_.base.md)<`number`>
**↳ Enum**
↳ [StorageFunctionModifier](_metadata_.storagefunctionmodifier.md)
↳ [NewAccountOutcome](_newaccountoutcome_.newaccountoutcome.md)
↳ [VoteThreshold](_votethreshold_.votethreshold.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new Enum**(def: *`EnumDef`*, value?: * [Enum](_codec_enum_.enum.md) &#124; `number`*): [Enum](_codec_enum_.enum.md)
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Enum.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L19)*
**Parameters:**
| Param | Type | Default value |
| ------ | ------ | ------ |
| def | `EnumDef` | - |
| `Default value` value | [Enum](_codec_enum_.enum.md) &#124; `number`| 0 |
**Returns:** [Enum](_codec_enum_.enum.md)
___
# Properties
<a id="raw"></a>
## raw
**● raw**: *`number`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L31)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Enum](_codec_enum_.enum.md)
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Enum.ts:35](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L35)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Enum](_codec_enum_.enum.md)
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Enum](_codec_enum_.enum.md)
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Enum.ts:42](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L42)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Enum](_codec_enum_.enum.md)
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Enum.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L49)*
**Returns:** `any`
___
<a id="tonumber"></a>
## toNumber
▸ **toNumber**(): `number`
*Defined in [codec/Enum.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L57)*
**Returns:** `number`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Enum.ts:61](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L61)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Enum.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L53)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
docs/types/classes/_codec_enumtype_.enumtype.md
+194
View File
@@ -0,0 +1,194 @@
# Type parameters
#### T
# Hierarchy
[Base](_codec_base_.base.md)<[Base](_codec_base_.base.md)<`T`>>
**↳ EnumType**
↳ [StorageFunctionType](_metadata_.storagefunctiontype.md)
↳ [MisbehaviorKind](_misbehaviorreport_.misbehaviorkind.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new EnumType**(def: *`TypesDef`*, index?: * `number` &#124; [EnumType](_codec_enumtype_.enumtype.md)<`T`>*, value?: *`any`*): [EnumType](_codec_enumtype_.enumtype.md)
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/EnumType.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L22)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| def | `TypesDef` |
| `Optional` index | `number` &#124; [EnumType](_codec_enumtype_.enumtype.md)<`T`>|
| `Optional` value | `any` |
**Returns:** [EnumType](_codec_enumtype_.enumtype.md)
___
# Properties
<a id="raw"></a>
## raw
**● raw**: *[Base](_codec_base_.base.md)<`T`>*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `string`
*Defined in [codec/EnumType.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L40)*
**Returns:** `string`
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/EnumType.ts:44](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L44)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Base](_codec_base_.base.md)<[Base](_codec_base_.base.md)<`T`>>
*Inherited from [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L29)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Base](_codec_base_.base.md)<[Base](_codec_base_.base.md)<`T`>>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [EnumType](_codec_enumtype_.enumtype.md)<`T`>
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/EnumType.ts:48](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L48)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [EnumType](_codec_enumtype_.enumtype.md)<`T`>
___
<a id="setvalue"></a>
## setValue
▸ **setValue**(index?: * [EnumType](_codec_enumtype_.enumtype.md)<`T`> &#124; `number`*, value?: *`any`*): `void`
*Defined in [codec/EnumType.ts:55](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L55)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` index | [EnumType](_codec_enumtype_.enumtype.md)<`T`> &#124; `number`|
| `Optional` value | `any` |
**Returns:** `void`
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/EnumType.ts:72](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L72)*
**Returns:** `any`
___
<a id="tonumber"></a>
## toNumber
▸ **toNumber**(): `number`
*Defined in [codec/EnumType.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L76)*
**Returns:** `number`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/EnumType.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L80)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Base.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L45)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
docs/types/classes/_codec_length_.length.md
+183
View File
@@ -0,0 +1,183 @@
# Hierarchy
[Base](_codec_base_.base.md)<`BN`>
**↳ Length**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new Length**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*, bitLength?: *`BitLength`*): [Length](_codec_length_.length.md)
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Length.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Length.ts#L26)*
**Parameters:**
| Param | Type | Default value |
| ------ | ------ | ------ |
| `Default value` value | [AnyNumber](../modules/_types_d_.md#anynumber) | new BN(0) |
| `Default value` bitLength | `BitLength` | 32 |
**Returns:** [Length](_codec_length_.length.md)
___
# Properties
<a id="raw"></a>
## raw
**● raw**: *`BN`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Length.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Length.ts#L36)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Base](_codec_base_.base.md)<`BN`>
*Inherited from [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L29)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Base](_codec_base_.base.md)<`BN`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Length](_codec_length_.length.md)
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Length.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Length.ts#L40)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Length](_codec_length_.length.md)
___
<a id="setvalue"></a>
## setValue
▸ **setValue**(value: * `BN` &#124; `number`*): `void`
*Defined in [codec/Length.ts:60](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Length.ts#L60)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| value | `BN` &#124; `number`|
**Returns:** `void`
___
<a id="tohex"></a>
## toHex
▸ **toHex**(): `string`
*Defined in [codec/Length.ts:46](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Length.ts#L46)*
**Returns:** `string`
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Base.ts:37](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L37)*
**Returns:** `any`
___
<a id="tonumber"></a>
## toNumber
▸ **toNumber**(): `number`
*Defined in [codec/Length.ts:50](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Length.ts#L50)*
**Returns:** `number`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Base.ts:41](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L41)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Length.ts:54](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Length.ts#L54)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
docs/types/classes/_codec_option_.option.md
+191
View File
@@ -0,0 +1,191 @@
# Type parameters
#### T
# Hierarchy
[Base](_codec_base_.base.md)<[Base](_codec_base_.base.md)<`T`>>
**↳ Option**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new Option**(Value: *`object`*, value?: *`any`*): [Option](_codec_option_.option.md)
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Option.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Option.ts#L14)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| Value | `object` |
| `Optional` value | `any` |
**Returns:** [Option](_codec_option_.option.md)
___
# Properties
<a id="raw"></a>
## raw
**● raw**: *[Base](_codec_base_.base.md)<`T`>*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="isempty"></a>
## isEmpty
getisEmpty(): `boolean`
*Defined in [codec/Option.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Option.ts#L32)*
**Returns:** `boolean`
___
<a id="value"></a>
## value
getvalue(): `T` &#124; `undefined`
*Defined in [codec/Option.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Option.ts#L36)*
**Returns:** `T` &#124; `undefined`
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Option.ts:42](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Option.ts#L42)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Option](_codec_option_.option.md)<`T`>
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Option.ts:50](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Option.ts#L50)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Option](_codec_option_.option.md)<`T`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Option](_codec_option_.option.md)<`T`>
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Option.ts:60](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Option.ts#L60)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Option](_codec_option_.option.md)<`T`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Option.ts:70](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Option.ts#L70)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Option.ts:91](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Option.ts#L91)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Option.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Option.ts#L76)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`O`>(Type: *`object`*): `object`
*Defined in [codec/Option.ts:24](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Option.ts#L24)*
**Type parameters:**
#### O
**Parameters:**
| Param | Type |
| ------ | ------ |
| Type | `object` |
**Returns:** `object`
___
docs/types/classes/_codec_struct_.struct.md
+314
View File
@@ -0,0 +1,314 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
[Base](_codec_base_.base.md)<`T`>
**↳ Struct**
↳ [Digest](_header_.digest.md)
↳ [Header](_header_.header.md)
↳ [Block](_block_.block.md)
↳ [Tuple](_codec_tuple_.tuple.md)
↳ [EventMetadata](_metadata_.eventmetadata.md)
↳ [OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)
↳ [OuterEventMetadata](_metadata_.outereventmetadata.md)
↳ [FunctionArgumentMetadata](_metadata_.functionargumentmetadata.md)
↳ [FunctionMetadata](_metadata_.functionmetadata.md)
↳ [CallMetadata](_metadata_.callmetadata.md)
↳ [ModuleMetadata](_metadata_.modulemetadata.md)
↳ [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)
↳ [StorageFunctionMetadata](_metadata_.storagefunctionmetadata.md)
↳ [StorageMetadata](_metadata_.storagemetadata.md)
↳ [RuntimeModuleMetadata](_metadata_.runtimemodulemetadata.md)
↳ [RuntimeMetadata](_metadata_.runtimemetadata.md)
↳ [KeyValue](_keyvalue_.keyvalue.md)
↳ [Justification](_bft_.justification.md)
↳ [BftAtReport](_misbehaviorreport_.bftatreport.md)
↳ [MisbehaviorReport](_misbehaviorreport_.misbehaviorreport.md)
↳ [RuntimeVersion](_runtimeversion_.runtimeversion.md)
↳ [SignedBlock](_signedblock_.signedblock.md)
↳ [StorageChangeSet](_storagechangeset_.storagechangeset.md)
↳ [ValidatorPrefs](_validatorprefs_.validatorprefs.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new Struct**(Types: *`S`*, value?: * `V` &#124; `Array`<`any`>*, jsonMap?: *`Map`<`keyof S`, `string`>*, isTuple?: *`boolean`*): [Struct](_codec_struct_.struct.md)
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
**Parameters:**
| Param | Type | Default value |
| ------ | ------ | ------ |
| Types | `S` | - |
| `Default value` value | `V` &#124; `Array`<`any`>| {} as V |
| `Default value` jsonMap | `Map`<`keyof S`, `string`> | new Map() |
| `Default value` isTuple | `boolean` | false |
**Returns:** [Struct](_codec_struct_.struct.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** [Base](_codec_base_.base.md)
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/types/classes/_codec_tuple_.tuple.md
+295
View File
@@ -0,0 +1,295 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
↳ [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`>
**↳ Tuple**
↳ [KeyValueOption](_keyvalue_.keyvalueoption.md)
↳ [BftAuthoritySignature](_bft_.bftauthoritysignature.md)
↳ [BftHashSignature](_bft_.bfthashsignature.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new Tuple**(Types: *`S`*, value?: * `V` &#124; `Array`<`any`>*, jsonMap?: *`Map`<`keyof S`, `string`>*): [Tuple](_codec_tuple_.tuple.md)
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [codec/Tuple.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L19)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| `Optional` value | `V` &#124; `Array`<`any`>|
| `Optional` jsonMap | `Map`<`keyof S`, `string`> |
**Returns:** [Tuple](_codec_tuple_.tuple.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)*
*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`>
*Overrides [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Defined in [codec/Tuple.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L34)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** [Base](_codec_base_.base.md)
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Tuple.ts:46](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L46)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)*
*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Tuple.ts:24](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L24)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/types/classes/_codec_u8a_.u8a.md
+174
View File
@@ -0,0 +1,174 @@
# Hierarchy
[Base](_codec_base_.base.md)<`Uint8Array`>
**↳ U8a**
↳ [AccountIndex](_accountindex_.accountindex.md)
↳ [Bytes](_bytes_.bytes.md)
↳ [U8aFixed](_codec_u8afixed_.u8afixed.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new U8a**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [U8a](_codec_u8a_.u8a.md)
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/U8a.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L16)*
**Parameters:**
| Param | Type | Default value |
| ------ | ------ | ------ |
| `Default value` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | new Uint8Array() |
**Returns:** [U8a](_codec_u8a_.u8a.md)
___
# Properties
<a id="raw"></a>
## raw
**● raw**: *`Uint8Array`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="length"></a>
## length
getlength(): `number`
*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L25)*
**Returns:** `number`
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/U8a.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L29)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [U8a](_codec_u8a_.u8a.md)
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/U8a.ts:33](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L33)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [U8a](_codec_u8a_.u8a.md)
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [U8a](_codec_u8a_.u8a.md)
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/U8a.ts:39](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L39)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [U8a](_codec_u8a_.u8a.md)
___
<a id="tohex"></a>
## toHex
▸ **toHex**(): `string`
*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)*
**Returns:** `string`
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L49)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L57)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L53)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
docs/types/classes/_codec_u8afixed_.u8afixed.md
+194
View File
@@ -0,0 +1,194 @@
# Hierarchy
↳ [U8a](_codec_u8a_.u8a.md)
**↳ U8aFixed**
↳ [H256](_h256_.h256.md)
↳ [H512](_h512_.h512.md)
↳ [AccountId](_accountid_.accountid.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new U8aFixed**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*, bitLength?: *`BitLength`*): [U8aFixed](_codec_u8afixed_.u8afixed.md)
*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)*
*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L14)*
**Parameters:**
| Param | Type | Default value |
| ------ | ------ | ------ |
| `Default value` value | [AnyU8a](../modules/_types_d_.md#anyu8a) | new Uint8Array() |
| `Default value` bitLength | `BitLength` | 256 |
**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md)
___
# Properties
<a id="_bitlength"></a>
## `<Protected>` _bitLength
**● _bitLength**: *`number`*
*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L14)*
___
<a id="raw"></a>
## raw
**● raw**: *`Uint8Array`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="length"></a>
## length
getlength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)*
*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L25)*
**Returns:** `number`
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)*
*Defined in [codec/U8aFixed.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L28)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [U8aFixed](_codec_u8afixed_.u8afixed.md)
*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L32)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md)
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [U8aFixed](_codec_u8afixed_.u8afixed.md)
*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)*
*Defined in [codec/U8aFixed.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L40)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md)
___
<a id="tohex"></a>
## toHex
▸ **toHex**(): `string`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)*
**Returns:** `string`
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L49)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L57)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L53)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
docs/types/classes/_codec_uint_.uint.md
+370
View File
@@ -0,0 +1,370 @@
# Hierarchy
[Base](_codec_base_.base.md)<`BN`>
**↳ UInt**
↳ [U128](_u128_.u128.md)
↳ [U64](_u64_.u64.md)
↳ [U16](_u16_.u16.md)
↳ [U32](_u32_.u32.md)
↳ [U8](_u8_.u8.md)
↳ [U256](_u256_.u256.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new UInt**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*, bitLength?: *`BitLength`*): [UInt](_codec_uint_.uint.md)
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/UInt.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L28)*
**Parameters:**
| Param | Type | Default value |
| ------ | ------ | ------ |
| `Default value` value | [AnyNumber](../modules/_types_d_.md#anynumber) | 0 |
| `Default value` bitLength | `BitLength` | 64 |
**Returns:** [UInt](_codec_uint_.uint.md)
___
# Properties
<a id="raw"></a>
## raw
**● raw**: *`BN`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Methods
<a id="add"></a>
## add
▸ **add**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `BN`
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L95)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| other | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `BN`
___
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L53)*
**Returns:** `number`
___
<a id="cmp"></a>
## cmp
▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `number`
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| other | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `number`
___
<a id="div"></a>
## div
▸ **div**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `BN`
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L107)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| other | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `BN`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md)
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L57)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [UInt](_codec_uint_.uint.md)
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md)
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L63)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [UInt](_codec_uint_.uint.md)
___
<a id="gt"></a>
## gt
▸ **gt**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| test | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `boolean`
___
<a id="gte"></a>
## gte
▸ **gte**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| test | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `boolean`
___
<a id="iszero"></a>
## isZero
▸ **isZero**(): `boolean`
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L113)*
**Returns:** `boolean`
___
<a id="lt"></a>
## lt
▸ **lt**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L117)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| test | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `boolean`
___
<a id="lte"></a>
## lte
▸ **lte**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L123)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| test | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `boolean`
___
<a id="mul"></a>
## mul
▸ **mul**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `BN`
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| other | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `BN`
___
<a id="sub"></a>
## sub
▸ **sub**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `BN`
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| other | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `BN`
___
<a id="tobn"></a>
## toBn
▸ **toBn**(): `BN`
*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L85)*
**Returns:** `BN`
___
<a id="tohex"></a>
## toHex
▸ **toHex**(): `string`
*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L69)*
**Returns:** `string`
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `any`
___
<a id="tonumber"></a>
## toNumber
▸ **toNumber**(): `number`
*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L89)*
**Returns:** `number`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L81)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L77)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN`
*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L38)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| value | [AnyNumber](../modules/_types_d_.md#anynumber) |
**Returns:** `BN`
___
docs/types/classes/_codec_vector_.vector.md
+319
View File
@@ -0,0 +1,319 @@
# Type parameters
#### T : [Base](_codec_base_.base.md)
# Hierarchy
[Base](_codec_base_.base.md)<`Array`<`T`>>
**↳ Vector**
↳ [Extrinsics](_extrinsics_.extrinsics.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new Vector**(Type: *`object`*, value?: *`Array`<`any`>*): [Vector](_codec_vector_.vector.md)
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L19)*
**Parameters:**
| Param | Type | Default value |
| ------ | ------ | ------ |
| Type | `object` | - |
| `Default value` value | `Array`<`any`> | [] as Array&lt;any&gt; |
**Returns:** [Vector](_codec_vector_.vector.md)
___
# Properties
<a id="raw"></a>
## raw
**● raw**: *`Array`<`T`>*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `string`
*Defined in [codec/Vector.ts:42](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L42)*
**Returns:** `string`
___
<a id="length"></a>
## length
getlength(): `number`
*Defined in [codec/Vector.ts:46](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L46)*
**Returns:** `number`
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Vector.ts:50](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L50)*
**Returns:** `number`
___
<a id="filter"></a>
## filter
▸ **filter**(fn: *`function`*): `Array`<`T`>
*Defined in [codec/Vector.ts:56](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L56)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| fn | `function` |
**Returns:** `Array`<`T`>
___
<a id="find"></a>
## find
▸ **find**(fn: *`function`*): `T` &#124; `undefined`
*Defined in [codec/Vector.ts:60](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L60)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| fn | `function` |
**Returns:** `T` &#124; `undefined`
___
<a id="foreach"></a>
## forEach
▸ **forEach**(fn: *`function`*): `any`
*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L64)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| fn | `function` |
**Returns:** `any`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Vector](_codec_vector_.vector.md)<`T`>
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Vector.ts:68](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L68)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Vector](_codec_vector_.vector.md)<`T`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Vector](_codec_vector_.vector.md)<`T`>
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Vector.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L76)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Vector](_codec_vector_.vector.md)<`T`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): `T`
*Defined in [codec/Vector.ts:93](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L93)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** `T`
___
<a id="map"></a>
## map
▸ **map**<`O`>(fn: *`function`*): `Array`<`O`>
*Defined in [codec/Vector.ts:97](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L97)*
**Type parameters:**
#### O
**Parameters:**
| Param | Type |
| ------ | ------ |
| fn | `function` |
**Returns:** `Array`<`O`>
___
<a id="push"></a>
## push
▸ **push**(item: *`T`*): `void`
*Defined in [codec/Vector.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| item | `T` |
**Returns:** `void`
___
<a id="reduce"></a>
## reduce
▸ **reduce**<`O`>(fn: *`function`*, initial: *`O`*): `O`
*Defined in [codec/Vector.ts:106](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L106)*
**Type parameters:**
#### O
**Parameters:**
| Param | Type |
| ------ | ------ |
| fn | `function` |
| initial | `O` |
**Returns:** `O`
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Vector.ts:110](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L110)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Vector.ts:125](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L125)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Vector.ts:116](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L116)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`O`>(Type: *`object`*): `object`
*Defined in [codec/Vector.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L34)*
**Type parameters:**
#### O : [Base](_codec_base_.base.md)
**Parameters:**
| Param | Type |
| ------ | ------ |
| Type | `object` |
**Returns:** `object`
___
docs/types/classes/_extrinsic_.extrinsic.md
+212
View File
@@ -0,0 +1,212 @@
# Hierarchy
↳ [Bytes](_bytes_.bytes.md)
**↳ Extrinsic**
↳ [Proposal](_proposal_.proposal.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new Extrinsic**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [Extrinsic](_extrinsic_.extrinsic.md)
*Inherited from [Bytes](_bytes_.bytes.md).[constructor](_bytes_.bytes.md#constructor)*
*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)*
*Defined in [Bytes.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L16)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | [AnyU8a](../modules/_types_d_.md#anyu8a) |
**Returns:** [Extrinsic](_extrinsic_.extrinsic.md)
___
# Properties
<a id="_length"></a>
## `<Protected>` _length
**● _length**: *[Length](_codec_length_.length.md)*
*Inherited from [Bytes](_bytes_.bytes.md).[_length](_bytes_.bytes.md#_length)*
*Defined in [Bytes.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L16)*
___
<a id="raw"></a>
## raw
**● raw**: *`Uint8Array`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="hash"></a>
## hash
gethash(): [Hash](_hash_.hash.md)
*Defined in [Extrinsic.ts:16](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Extrinsic.ts#L16)*
**Returns:** [Hash](_hash_.hash.md)
___
<a id="length"></a>
## length
getlength(): `number`
*Inherited from [Bytes](_bytes_.bytes.md).[length](_bytes_.bytes.md#length)*
*Overrides [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)*
*Defined in [Bytes.ts:24](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L24)*
**Returns:** `number`
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Bytes](_bytes_.bytes.md).[byteLength](_bytes_.bytes.md#bytelength)*
*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)*
*Defined in [Bytes.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L28)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Bytes](_bytes_.bytes.md)
*Inherited from [Bytes](_bytes_.bytes.md).[fromJSON](_bytes_.bytes.md#fromjson)*
*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)*
*Defined in [Bytes.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L32)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Bytes](_bytes_.bytes.md)
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Bytes](_bytes_.bytes.md)
*Inherited from [Bytes](_bytes_.bytes.md).[fromU8a](_bytes_.bytes.md#fromu8a)*
*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)*
*Defined in [Bytes.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L40)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Bytes](_bytes_.bytes.md)
___
<a id="tohex"></a>
## toHex
▸ **toHex**(): `string`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)*
**Returns:** `string`
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L49)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L57)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Bytes](_bytes_.bytes.md).[toU8a](_bytes_.bytes.md#tou8a)*
*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [Bytes.ts:51](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Bytes.ts#L51)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
docs/types/classes/_extrinsics_.extrinsics.md
+353
View File
@@ -0,0 +1,353 @@
# Type parameters
#### T : [Base](_codec_base_.base.md)
# Hierarchy
↳ [Vector](_codec_vector_.vector.md)
**↳ Extrinsics**
↳ [PendingExtrinsics](_pendingextrinsics_.pendingextrinsics.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new Extrinsics**(Type: *`object`*, value?: *`Array`<`any`>*): [Extrinsics](_extrinsics_.extrinsics.md)
*Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)*
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Vector.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L19)*
**Parameters:**
| Param | Type | Default value |
| ------ | ------ | ------ |
| Type | `object` | - |
| `Default value` value | `Array`<`any`> | [] as Array&lt;any&gt; |
**Returns:** [Extrinsics](_extrinsics_.extrinsics.md)
___
# Properties
<a id="raw"></a>
## raw
**● raw**: *`Array`<`T`>*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `string`
*Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)*
*Defined in [codec/Vector.ts:42](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L42)*
**Returns:** `string`
___
<a id="length"></a>
## length
getlength(): `number`
*Inherited from [Vector](_codec_vector_.vector.md).[length](_codec_vector_.vector.md#length)*
*Defined in [codec/Vector.ts:46](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L46)*
**Returns:** `number`
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Vector](_codec_vector_.vector.md).[byteLength](_codec_vector_.vector.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Vector.ts:50](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L50)*
**Returns:** `number`
___
<a id="filter"></a>
## filter
▸ **filter**(fn: *`function`*): `Array`<`T`>
*Inherited from [Vector](_codec_vector_.vector.md).[filter](_codec_vector_.vector.md#filter)*
*Defined in [codec/Vector.ts:56](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L56)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| fn | `function` |
**Returns:** `Array`<`T`>
___
<a id="find"></a>
## find
▸ **find**(fn: *`function`*): `T` &#124; `undefined`
*Inherited from [Vector](_codec_vector_.vector.md).[find](_codec_vector_.vector.md#find)*
*Defined in [codec/Vector.ts:60](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L60)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| fn | `function` |
**Returns:** `T` &#124; `undefined`
___
<a id="foreach"></a>
## forEach
▸ **forEach**(fn: *`function`*): `any`
*Inherited from [Vector](_codec_vector_.vector.md).[forEach](_codec_vector_.vector.md#foreach)*
*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L64)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| fn | `function` |
**Returns:** `any`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Vector](_codec_vector_.vector.md)<`T`>
*Inherited from [Vector](_codec_vector_.vector.md).[fromJSON](_codec_vector_.vector.md#fromjson)*
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Vector.ts:68](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L68)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Vector](_codec_vector_.vector.md)<`T`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Vector](_codec_vector_.vector.md)<`T`>
*Inherited from [Vector](_codec_vector_.vector.md).[fromU8a](_codec_vector_.vector.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Vector.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L76)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Vector](_codec_vector_.vector.md)<`T`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): `T`
*Inherited from [Vector](_codec_vector_.vector.md).[get](_codec_vector_.vector.md#get)*
*Defined in [codec/Vector.ts:93](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L93)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** `T`
___
<a id="map"></a>
## map
▸ **map**<`O`>(fn: *`function`*): `Array`<`O`>
*Inherited from [Vector](_codec_vector_.vector.md).[map](_codec_vector_.vector.md#map)*
*Defined in [codec/Vector.ts:97](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L97)*
**Type parameters:**
#### O
**Parameters:**
| Param | Type |
| ------ | ------ |
| fn | `function` |
**Returns:** `Array`<`O`>
___
<a id="push"></a>
## push
▸ **push**(item: *`T`*): `void`
*Inherited from [Vector](_codec_vector_.vector.md).[push](_codec_vector_.vector.md#push)*
*Defined in [codec/Vector.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| item | `T` |
**Returns:** `void`
___
<a id="reduce"></a>
## reduce
▸ **reduce**<`O`>(fn: *`function`*, initial: *`O`*): `O`
*Inherited from [Vector](_codec_vector_.vector.md).[reduce](_codec_vector_.vector.md#reduce)*
*Defined in [codec/Vector.ts:106](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L106)*
**Type parameters:**
#### O
**Parameters:**
| Param | Type |
| ------ | ------ |
| fn | `function` |
| initial | `O` |
**Returns:** `O`
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Vector.ts:110](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L110)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Vector](_codec_vector_.vector.md).[toString](_codec_vector_.vector.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Vector.ts:125](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L125)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Vector.ts:116](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L116)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`O`>(Type: *`object`*): `object`
*Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)*
*Defined in [codec/Vector.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Vector.ts#L34)*
**Type parameters:**
#### O : [Base](_codec_base_.base.md)
**Parameters:**
| Param | Type |
| ------ | ------ |
| Type | `object` |
**Returns:** `object`
___
docs/types/classes/_gas_.gas.md
+399
View File
@@ -0,0 +1,399 @@
# Hierarchy
↳ [U64](_u64_.u64.md)
**↳ Gas**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new Gas**(value?: *[AnyNumber](../modules/_types_d_.md#anynumber)*): [Gas](_gas_.gas.md)
*Inherited from [U64](_u64_.u64.md).[constructor](_u64_.u64.md#constructor)*
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
*Defined in [U64.ts:9](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/U64.ts#L9)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | [AnyNumber](../modules/_types_d_.md#anynumber) |
**Returns:** [Gas](_gas_.gas.md)
___
# Properties
<a id="raw"></a>
## raw
**● raw**: *`BN`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Methods
<a id="add"></a>
## add
▸ **add**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `BN`
*Inherited from [UInt](_codec_uint_.uint.md).[add](_codec_uint_.uint.md#add)*
*Defined in [codec/UInt.ts:95](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L95)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| other | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `BN`
___
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [UInt](_codec_uint_.uint.md).[byteLength](_codec_uint_.uint.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/UInt.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L53)*
**Returns:** `number`
___
<a id="cmp"></a>
## cmp
▸ **cmp**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `number`
*Inherited from [UInt](_codec_uint_.uint.md).[cmp](_codec_uint_.uint.md#cmp)*
*Defined in [codec/UInt.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| other | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `number`
___
<a id="div"></a>
## div
▸ **div**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `BN`
*Inherited from [UInt](_codec_uint_.uint.md).[div](_codec_uint_.uint.md#div)*
*Defined in [codec/UInt.ts:107](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L107)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| other | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `BN`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [UInt](_codec_uint_.uint.md)
*Inherited from [UInt](_codec_uint_.uint.md).[fromJSON](_codec_uint_.uint.md#fromjson)*
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/UInt.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L57)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [UInt](_codec_uint_.uint.md)
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [UInt](_codec_uint_.uint.md)
*Inherited from [UInt](_codec_uint_.uint.md).[fromU8a](_codec_uint_.uint.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/UInt.ts:63](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L63)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [UInt](_codec_uint_.uint.md)
___
<a id="gt"></a>
## gt
▸ **gt**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Inherited from [UInt](_codec_uint_.uint.md).[gt](_codec_uint_.uint.md#gt)*
*Defined in [codec/UInt.ts:129](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L129)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| test | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `boolean`
___
<a id="gte"></a>
## gte
▸ **gte**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Inherited from [UInt](_codec_uint_.uint.md).[gte](_codec_uint_.uint.md#gte)*
*Defined in [codec/UInt.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L135)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| test | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `boolean`
___
<a id="iszero"></a>
## isZero
▸ **isZero**(): `boolean`
*Inherited from [UInt](_codec_uint_.uint.md).[isZero](_codec_uint_.uint.md#iszero)*
*Defined in [codec/UInt.ts:113](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L113)*
**Returns:** `boolean`
___
<a id="lt"></a>
## lt
▸ **lt**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Inherited from [UInt](_codec_uint_.uint.md).[lt](_codec_uint_.uint.md#lt)*
*Defined in [codec/UInt.ts:117](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L117)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| test | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `boolean`
___
<a id="lte"></a>
## lte
▸ **lte**(test: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `boolean`
*Inherited from [UInt](_codec_uint_.uint.md).[lte](_codec_uint_.uint.md#lte)*
*Defined in [codec/UInt.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L123)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| test | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `boolean`
___
<a id="mul"></a>
## mul
▸ **mul**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `BN`
*Inherited from [UInt](_codec_uint_.uint.md).[mul](_codec_uint_.uint.md#mul)*
*Defined in [codec/UInt.ts:141](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L141)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| other | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `BN`
___
<a id="sub"></a>
## sub
▸ **sub**(other: * [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`*): `BN`
*Inherited from [UInt](_codec_uint_.uint.md).[sub](_codec_uint_.uint.md#sub)*
*Defined in [codec/UInt.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L147)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| other | [UInt](_codec_uint_.uint.md) &#124; `BN` &#124; `number`|
**Returns:** `BN`
___
<a id="tobn"></a>
## toBn
▸ **toBn**(): `BN`
*Inherited from [UInt](_codec_uint_.uint.md).[toBn](_codec_uint_.uint.md#tobn)*
*Defined in [codec/UInt.ts:85](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L85)*
**Returns:** `BN`
___
<a id="tohex"></a>
## toHex
▸ **toHex**(): `string`
*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
*Defined in [codec/UInt.ts:69](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L69)*
**Returns:** `string`
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [UInt](_codec_uint_.uint.md).[toJSON](_codec_uint_.uint.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/UInt.ts:73](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L73)*
**Returns:** `any`
___
<a id="tonumber"></a>
## toNumber
▸ **toNumber**(): `number`
*Inherited from [UInt](_codec_uint_.uint.md).[toNumber](_codec_uint_.uint.md#tonumber)*
*Defined in [codec/UInt.ts:89](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L89)*
**Returns:** `number`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [UInt](_codec_uint_.uint.md).[toString](_codec_uint_.uint.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/UInt.ts:81](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L81)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/UInt.ts:77](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L77)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**(value: *[AnyNumber](../modules/_types_d_.md#anynumber)*): `BN`
*Inherited from [UInt](_codec_uint_.uint.md).[decode](_codec_uint_.uint.md#decode)*
*Defined in [codec/UInt.ts:38](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/UInt.ts#L38)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| value | [AnyNumber](../modules/_types_d_.md#anynumber) |
**Returns:** `BN`
___
docs/types/classes/_h256_.h256.md
+197
View File
@@ -0,0 +1,197 @@
# Hierarchy
↳ [U8aFixed](_codec_u8afixed_.u8afixed.md)
**↳ H256**
↳ [Hash](_hash_.hash.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new H256**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [H256](_h256_.h256.md)
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/H256.ts#L11)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | [AnyU8a](../modules/_types_d_.md#anyu8a) |
**Returns:** [H256](_h256_.h256.md)
___
# Properties
<a id="_bitlength"></a>
## `<Protected>` _bitLength
**● _bitLength**: *`number`*
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[_bitLength](_codec_u8afixed_.u8afixed.md#_bitlength)*
*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L14)*
___
<a id="raw"></a>
## raw
**● raw**: *`Uint8Array`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="length"></a>
## length
getlength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)*
*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L25)*
**Returns:** `number`
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[byteLength](_codec_u8afixed_.u8afixed.md#bytelength)*
*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)*
*Defined in [codec/U8aFixed.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L28)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [U8aFixed](_codec_u8afixed_.u8afixed.md)
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromJSON](_codec_u8afixed_.u8afixed.md#fromjson)*
*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L32)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md)
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [U8aFixed](_codec_u8afixed_.u8afixed.md)
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromU8a](_codec_u8afixed_.u8afixed.md#fromu8a)*
*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)*
*Defined in [codec/U8aFixed.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L40)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md)
___
<a id="tohex"></a>
## toHex
▸ **toHex**(): `string`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)*
**Returns:** `string`
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L49)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L57)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L53)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
docs/types/classes/_h512_.h512.md
+197
View File
@@ -0,0 +1,197 @@
# Hierarchy
↳ [U8aFixed](_codec_u8afixed_.u8afixed.md)
**↳ H512**
↳ [Signature](_signature_.signature.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new H512**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [H512](_h512_.h512.md)
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [H512.ts:10](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/H512.ts#L10)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | [AnyU8a](../modules/_types_d_.md#anyu8a) |
**Returns:** [H512](_h512_.h512.md)
___
# Properties
<a id="_bitlength"></a>
## `<Protected>` _bitLength
**● _bitLength**: *`number`*
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[_bitLength](_codec_u8afixed_.u8afixed.md#_bitlength)*
*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L14)*
___
<a id="raw"></a>
## raw
**● raw**: *`Uint8Array`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="length"></a>
## length
getlength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)*
*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L25)*
**Returns:** `number`
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[byteLength](_codec_u8afixed_.u8afixed.md#bytelength)*
*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)*
*Defined in [codec/U8aFixed.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L28)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [U8aFixed](_codec_u8afixed_.u8afixed.md)
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromJSON](_codec_u8afixed_.u8afixed.md#fromjson)*
*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L32)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md)
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [U8aFixed](_codec_u8afixed_.u8afixed.md)
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromU8a](_codec_u8afixed_.u8afixed.md#fromu8a)*
*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)*
*Defined in [codec/U8aFixed.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L40)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md)
___
<a id="tohex"></a>
## toHex
▸ **toHex**(): `string`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)*
**Returns:** `string`
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L49)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L57)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L53)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
docs/types/classes/_hash_.hash.md
+197
View File
@@ -0,0 +1,197 @@
# Hierarchy
↳ [H256](_h256_.h256.md)
**↳ Hash**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new Hash**(value?: *[AnyU8a](../modules/_types_d_.md#anyu8a)*): [Hash](_hash_.hash.md)
*Inherited from [H256](_h256_.h256.md).[constructor](_h256_.h256.md#constructor)*
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [H256.ts:11](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/H256.ts#L11)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | [AnyU8a](../modules/_types_d_.md#anyu8a) |
**Returns:** [Hash](_hash_.hash.md)
___
# Properties
<a id="_bitlength"></a>
## `<Protected>` _bitLength
**● _bitLength**: *`number`*
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[_bitLength](_codec_u8afixed_.u8afixed.md#_bitlength)*
*Defined in [codec/U8aFixed.ts:14](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L14)*
___
<a id="raw"></a>
## raw
**● raw**: *`Uint8Array`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="length"></a>
## length
getlength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)*
*Defined in [codec/U8a.ts:25](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L25)*
**Returns:** `number`
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[byteLength](_codec_u8afixed_.u8afixed.md#bytelength)*
*Overrides [U8a](_codec_u8a_.u8a.md).[byteLength](_codec_u8a_.u8a.md#bytelength)*
*Defined in [codec/U8aFixed.ts:28](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L28)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [U8aFixed](_codec_u8afixed_.u8afixed.md)
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromJSON](_codec_u8afixed_.u8afixed.md#fromjson)*
*Overrides [U8a](_codec_u8a_.u8a.md).[fromJSON](_codec_u8a_.u8a.md#fromjson)*
*Defined in [codec/U8aFixed.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L32)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md)
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [U8aFixed](_codec_u8afixed_.u8afixed.md)
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[fromU8a](_codec_u8afixed_.u8afixed.md#fromu8a)*
*Overrides [U8a](_codec_u8a_.u8a.md).[fromU8a](_codec_u8a_.u8a.md#fromu8a)*
*Defined in [codec/U8aFixed.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8aFixed.ts#L40)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md)
___
<a id="tohex"></a>
## toHex
▸ **toHex**(): `string`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L45)*
**Returns:** `string`
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/U8a.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L49)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/U8a.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L57)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/U8a.ts#L53)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
docs/types/classes/_header_.digest.md
+302
View File
@@ -0,0 +1,302 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
↳ [Struct](_codec_struct_.struct.md)
**↳ Digest**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new Digest**(value?: *`DigestValue`*): [Digest](_header_.digest.md)
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Header.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Header.ts#L29)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | `DigestValue` |
**Returns:** [Digest](_header_.digest.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)*
*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="logs"></a>
## logs
getlogs(): [Vector](_codec_vector_.vector.md)<[Bytes](_bytes_.bytes.md)>
*Defined in [Header.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Header.ts#L36)*
**Returns:** [Vector](_codec_vector_.vector.md)<[Bytes](_bytes_.bytes.md)>
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** [Base](_codec_base_.base.md)
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)*
*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/types/classes/_header_.header.md
+357
View File
@@ -0,0 +1,357 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
↳ [Struct](_codec_struct_.struct.md)
**↳ Header**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new Header**(value?: *[HeaderValue](../modules/_header_.md#headervalue)*): [Header](_header_.header.md)
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Header.ts:42](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Header.ts#L42)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | [HeaderValue](../modules/_header_.md#headervalue) |
**Returns:** [Header](_header_.header.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)*
*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="blocknumber"></a>
## blockNumber
getblockNumber(): [BlockNumber](_blocknumber_.blocknumber.md)
*Defined in [Header.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Header.ts#L53)*
**Returns:** [BlockNumber](_blocknumber_.blocknumber.md)
___
<a id="digest"></a>
## digest
getdigest(): [Digest](_header_.digest.md)
*Defined in [Header.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Header.ts#L57)*
**Returns:** [Digest](_header_.digest.md)
___
<a id="extrinsicsroot"></a>
## extrinsicsRoot
getextrinsicsRoot(): [Hash](_hash_.hash.md)
*Defined in [Header.ts:61](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Header.ts#L61)*
**Returns:** [Hash](_hash_.hash.md)
___
<a id="hash"></a>
## hash
gethash(): [Hash](_hash_.hash.md)
*Defined in [Header.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Header.ts#L66)*
**Returns:** [Hash](_hash_.hash.md)
___
<a id="parenthash"></a>
## parentHash
getparentHash(): [Hash](_hash_.hash.md)
*Defined in [Header.ts:72](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Header.ts#L72)*
**Returns:** [Hash](_hash_.hash.md)
___
<a id="stateroot"></a>
## stateRoot
getstateRoot(): [Hash](_hash_.hash.md)
*Defined in [Header.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Header.ts#L76)*
**Returns:** [Hash](_hash_.hash.md)
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** [Base](_codec_base_.base.md)
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)*
*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/types/classes/_keyvalue_.keyvalue.md
+313
View File
@@ -0,0 +1,313 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
↳ [Struct](_codec_struct_.struct.md)
**↳ KeyValue**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new KeyValue**(value?: *`KeyValueValue`*): [KeyValue](_keyvalue_.keyvalue.md)
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [KeyValue.ts:22](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/KeyValue.ts#L22)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | `KeyValueValue` |
**Returns:** [KeyValue](_keyvalue_.keyvalue.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)*
*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="key"></a>
## key
getkey(): [StorageKey](_storagekey_.storagekey.md)
*Defined in [KeyValue.ts:30](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/KeyValue.ts#L30)*
**Returns:** [StorageKey](_storagekey_.storagekey.md)
___
<a id="value"></a>
## value
getvalue(): [StorageData](_storagedata_.storagedata.md)
*Defined in [KeyValue.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/KeyValue.ts#L34)*
**Returns:** [StorageData](_storagedata_.storagedata.md)
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** [Base](_codec_base_.base.md)
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)*
*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/types/classes/_keyvalue_.keyvalueoption.md
+315
View File
@@ -0,0 +1,315 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
↳ [Tuple](_codec_tuple_.tuple.md)
**↳ KeyValueOption**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new KeyValueOption**(value?: *[KeyValueOptionValue](../modules/_keyvalue_.md#keyvalueoptionvalue)*): [KeyValueOption](_keyvalue_.keyvalueoption.md)
*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [KeyValue.ts:47](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/KeyValue.ts#L47)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | [KeyValueOptionValue](../modules/_keyvalue_.md#keyvalueoptionvalue) |
**Returns:** [KeyValueOption](_keyvalue_.keyvalueoption.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)*
*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="key"></a>
## key
getkey(): [StorageKey](_storagekey_.storagekey.md)
*Defined in [KeyValue.ts:55](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/KeyValue.ts#L55)*
**Returns:** [StorageKey](_storagekey_.storagekey.md)
___
<a id="value"></a>
## value
getvalue(): [Option](_codec_option_.option.md)<[StorageData](_storagedata_.storagedata.md)>
*Defined in [KeyValue.ts:59](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/KeyValue.ts#L59)*
**Returns:** [Option](_codec_option_.option.md)<[StorageData](_storagedata_.storagedata.md)>
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`>
*Inherited from [Tuple](_codec_tuple_.tuple.md).[fromJSON](_codec_tuple_.tuple.md#fromjson)*
*Overrides [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Defined in [codec/Tuple.ts:34](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L34)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Tuple](_codec_tuple_.tuple.md)<`S`, `T`, `V`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** [Base](_codec_base_.base.md)
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Tuple.ts:46](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L46)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)*
*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
*Overrides [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Tuple.ts:24](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Tuple.ts#L24)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/types/classes/_metadata_.callmetadata.md
+313
View File
@@ -0,0 +1,313 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
↳ [Struct](_codec_struct_.struct.md)
**↳ CallMetadata**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new CallMetadata**(value?: *`any`*): [CallMetadata](_metadata_.callmetadata.md)
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Metadata.ts:123](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L123)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | `any` |
**Returns:** [CallMetadata](_metadata_.callmetadata.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)*
*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="functions"></a>
## functions
getfunctions(): [Vector](_codec_vector_.vector.md)<[FunctionMetadata](_metadata_.functionmetadata.md)>
*Defined in [Metadata.ts:131](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L131)*
**Returns:** [Vector](_codec_vector_.vector.md)<[FunctionMetadata](_metadata_.functionmetadata.md)>
___
<a id="name"></a>
## name
getname(): [Text](_text_.text.md)
*Defined in [Metadata.ts:135](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L135)*
**Returns:** [Text](_text_.text.md)
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** [Base](_codec_base_.base.md)
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)*
*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/types/classes/_metadata_.eventmetadata.md
+324
View File
@@ -0,0 +1,324 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
↳ [Struct](_codec_struct_.struct.md)
**↳ EventMetadata**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new EventMetadata**(value?: *`any`*): [EventMetadata](_metadata_.eventmetadata.md)
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Metadata.ts:23](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L23)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | `any` |
**Returns:** [EventMetadata](_metadata_.eventmetadata.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)*
*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="arguments"></a>
## arguments
getarguments(): [Vector](_codec_vector_.vector.md)<[Type](_type_.type.md)>
*Defined in [Metadata.ts:32](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L32)*
**Returns:** [Vector](_codec_vector_.vector.md)<[Type](_type_.type.md)>
___
<a id="documentation"></a>
## documentation
getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)>
*Defined in [Metadata.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L36)*
**Returns:** [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)>
___
<a id="name"></a>
## name
getname(): [Text](_text_.text.md)
*Defined in [Metadata.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L40)*
**Returns:** [Text](_text_.text.md)
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** [Base](_codec_base_.base.md)
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)*
*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/types/classes/_metadata_.functionargumentmetadata.md
+313
View File
@@ -0,0 +1,313 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
↳ [Struct](_codec_struct_.struct.md)
**↳ FunctionArgumentMetadata**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new FunctionArgumentMetadata**(value?: *`any`*): [FunctionArgumentMetadata](_metadata_.functionargumentmetadata.md)
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Metadata.ts:79](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L79)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | `any` |
**Returns:** [FunctionArgumentMetadata](_metadata_.functionargumentmetadata.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)*
*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="name"></a>
## name
getname(): [Text](_text_.text.md)
*Defined in [Metadata.ts:87](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L87)*
**Returns:** [Text](_text_.text.md)
___
<a id="type-1"></a>
## type
gettype(): [Type](_type_.type.md)
*Defined in [Metadata.ts:91](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L91)*
**Returns:** [Type](_type_.type.md)
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** [Base](_codec_base_.base.md)
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)*
*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/types/classes/_metadata_.functionmetadata.md
+335
View File
@@ -0,0 +1,335 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
↳ [Struct](_codec_struct_.struct.md)
**↳ FunctionMetadata**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new FunctionMetadata**(value?: *`any`*): [FunctionMetadata](_metadata_.functionmetadata.md)
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Metadata.ts:96](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L96)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | `any` |
**Returns:** [FunctionMetadata](_metadata_.functionmetadata.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)*
*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="arguments"></a>
## arguments
getarguments(): [Vector](_codec_vector_.vector.md)<[FunctionArgumentMetadata](_metadata_.functionargumentmetadata.md)>
*Defined in [Metadata.ts:106](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L106)*
**Returns:** [Vector](_codec_vector_.vector.md)<[FunctionArgumentMetadata](_metadata_.functionargumentmetadata.md)>
___
<a id="documentation"></a>
## documentation
getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)>
*Defined in [Metadata.ts:110](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L110)*
**Returns:** [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)>
___
<a id="id"></a>
## id
getid(): [U16](_u16_.u16.md)
*Defined in [Metadata.ts:114](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L114)*
**Returns:** [U16](_u16_.u16.md)
___
<a id="name"></a>
## name
getname(): [Text](_text_.text.md)
*Defined in [Metadata.ts:118](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L118)*
**Returns:** [Text](_text_.text.md)
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** [Base](_codec_base_.base.md)
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)*
*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/types/classes/_metadata_.modulemetadata.md
+313
View File
@@ -0,0 +1,313 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
↳ [Struct](_codec_struct_.struct.md)
**↳ ModuleMetadata**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new ModuleMetadata**(value?: *`any`*): [ModuleMetadata](_metadata_.modulemetadata.md)
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Metadata.ts:140](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L140)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | `any` |
**Returns:** [ModuleMetadata](_metadata_.modulemetadata.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)*
*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="call"></a>
## call
getcall(): [CallMetadata](_metadata_.callmetadata.md)
*Defined in [Metadata.ts:148](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L148)*
**Returns:** [CallMetadata](_metadata_.callmetadata.md)
___
<a id="name"></a>
## name
getname(): [Text](_text_.text.md)
*Defined in [Metadata.ts:152](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L152)*
**Returns:** [Text](_text_.text.md)
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** [Base](_codec_base_.base.md)
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)*
*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/types/classes/_metadata_.outereventmetadata.md
+313
View File
@@ -0,0 +1,313 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
↳ [Struct](_codec_struct_.struct.md)
**↳ OuterEventMetadata**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new OuterEventMetadata**(value?: *`any`*): [OuterEventMetadata](_metadata_.outereventmetadata.md)
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Metadata.ts:62](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L62)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | `any` |
**Returns:** [OuterEventMetadata](_metadata_.outereventmetadata.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)*
*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="events"></a>
## events
getevents(): [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)>
*Defined in [Metadata.ts:70](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L70)*
**Returns:** [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)>
___
<a id="name"></a>
## name
getname(): [Text](_text_.text.md)
*Defined in [Metadata.ts:74](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L74)*
**Returns:** [Text](_text_.text.md)
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** [Base](_codec_base_.base.md)
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)*
*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/types/classes/_metadata_.outereventmetadataevent.md
+313
View File
@@ -0,0 +1,313 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
↳ [Struct](_codec_struct_.struct.md)
**↳ OuterEventMetadataEvent**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new OuterEventMetadataEvent**(value?: *`any`*): [OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Metadata.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L45)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | `any` |
**Returns:** [OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)*
*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="events"></a>
## events
getevents(): [Vector](_codec_vector_.vector.md)<[EventMetadata](_metadata_.eventmetadata.md)>
*Defined in [Metadata.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L53)*
**Returns:** [Vector](_codec_vector_.vector.md)<[EventMetadata](_metadata_.eventmetadata.md)>
___
<a id="name"></a>
## name
getname(): [Text](_text_.text.md)
*Defined in [Metadata.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L57)*
**Returns:** [Text](_text_.text.md)
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** [Base](_codec_base_.base.md)
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)*
*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/types/classes/_metadata_.runtimemetadata.md
+320
View File
@@ -0,0 +1,320 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
↳ [Struct](_codec_struct_.struct.md)
**↳ RuntimeMetadata**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new RuntimeMetadata**(value?: *`any`*): [RuntimeMetadata](_metadata_.runtimemetadata.md)
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Metadata.ts:280](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L280)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | `any` |
**Returns:** [RuntimeMetadata](_metadata_.runtimemetadata.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)*
*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="events"></a>
## events
getevents(): [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)>
*Defined in [Metadata.ts:303](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L303)*
**Returns:** [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_.outereventmetadataevent.md)>
___
<a id="modules"></a>
## modules
getmodules(): [Vector](_codec_vector_.vector.md)<[RuntimeModuleMetadata](_metadata_.runtimemodulemetadata.md)>
*Defined in [Metadata.ts:307](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L307)*
**Returns:** [Vector](_codec_vector_.vector.md)<[RuntimeModuleMetadata](_metadata_.runtimemodulemetadata.md)>
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: * `Uint8Array` &#124; `string` &#124; `Array`<`number`>*): [RuntimeMetadata](_metadata_.runtimemetadata.md)
*Overrides [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Defined in [Metadata.ts:290](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L290)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` &#124; `string` &#124; `Array`<`number`>|
**Returns:** [RuntimeMetadata](_metadata_.runtimemetadata.md)
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** [Base](_codec_base_.base.md)
___
<a id="getuniqtypes"></a>
## getUniqTypes
▸ **getUniqTypes**(): `Array`<`string`>
*Defined in [Metadata.ts:312](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L312)*
**Returns:** `Array`<`string`>
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [Metadata.ts:299](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L299)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)*
*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/types/classes/_metadata_.runtimemodulemetadata.md
+324
View File
@@ -0,0 +1,324 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
↳ [Struct](_codec_struct_.struct.md)
**↳ RuntimeModuleMetadata**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new RuntimeModuleMetadata**(value?: *`any`*): [RuntimeModuleMetadata](_metadata_.runtimemodulemetadata.md)
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Metadata.ts:258](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L258)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | `any` |
**Returns:** [RuntimeModuleMetadata](_metadata_.runtimemodulemetadata.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)*
*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="module"></a>
## module
getmodule(): [ModuleMetadata](_metadata_.modulemetadata.md)
*Defined in [Metadata.ts:267](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L267)*
**Returns:** [ModuleMetadata](_metadata_.modulemetadata.md)
___
<a id="prefix"></a>
## prefix
getprefix(): [Text](_text_.text.md)
*Defined in [Metadata.ts:271](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L271)*
**Returns:** [Text](_text_.text.md)
___
<a id="storage"></a>
## storage
getstorage(): [StorageMetadata](_metadata_.storagemetadata.md) &#124; `undefined`
*Defined in [Metadata.ts:275](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L275)*
**Returns:** [StorageMetadata](_metadata_.storagemetadata.md) &#124; `undefined`
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** [Base](_codec_base_.base.md)
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)*
*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/types/classes/_metadata_.storagefunctionmetadata.md
+335
View File
@@ -0,0 +1,335 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
↳ [Struct](_codec_struct_.struct.md)
**↳ StorageFunctionMetadata**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new StorageFunctionMetadata**(value?: *`StorageFunctionMetadataValue`*): [StorageFunctionMetadata](_metadata_.storagefunctionmetadata.md)
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Metadata.ts:214](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L214)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | `StorageFunctionMetadataValue` |
**Returns:** [StorageFunctionMetadata](_metadata_.storagefunctionmetadata.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)*
*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="documentation"></a>
## documentation
getdocumentation(): [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)>
*Defined in [Metadata.ts:224](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L224)*
**Returns:** [Vector](_codec_vector_.vector.md)<[Text](_text_.text.md)>
___
<a id="modifier"></a>
## modifier
getmodifier(): [StorageFunctionModifier](_metadata_.storagefunctionmodifier.md)
*Defined in [Metadata.ts:232](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L232)*
**Returns:** [StorageFunctionModifier](_metadata_.storagefunctionmodifier.md)
___
<a id="name"></a>
## name
getname(): [Text](_text_.text.md)
*Defined in [Metadata.ts:228](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L228)*
**Returns:** [Text](_text_.text.md)
___
<a id="type-1"></a>
## type
gettype(): [StorageFunctionType](_metadata_.storagefunctiontype.md)
*Defined in [Metadata.ts:236](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L236)*
**Returns:** [StorageFunctionType](_metadata_.storagefunctiontype.md)
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** [Base](_codec_base_.base.md)
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)*
*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/types/classes/_metadata_.storagefunctionmodifier.md
+168
View File
@@ -0,0 +1,168 @@
# Hierarchy
↳ [Enum](_codec_enum_.enum.md)
**↳ StorageFunctionModifier**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new StorageFunctionModifier**(value?: *`any`*): [StorageFunctionModifier](_metadata_.storagefunctionmodifier.md)
*Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)*
*Defined in [Metadata.ts:157](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L157)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | `any` |
**Returns:** [StorageFunctionModifier](_metadata_.storagefunctionmodifier.md)
___
# Properties
<a id="raw"></a>
## raw
**● raw**: *`number`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Enum](_codec_enum_.enum.md).[byteLength](_codec_enum_.enum.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Enum.ts:31](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L31)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Enum](_codec_enum_.enum.md)
*Inherited from [Enum](_codec_enum_.enum.md).[fromJSON](_codec_enum_.enum.md#fromjson)*
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Enum.ts:35](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L35)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Enum](_codec_enum_.enum.md)
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Enum](_codec_enum_.enum.md)
*Inherited from [Enum](_codec_enum_.enum.md).[fromU8a](_codec_enum_.enum.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Enum.ts:42](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L42)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Enum](_codec_enum_.enum.md)
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [Enum](_codec_enum_.enum.md).[toJSON](_codec_enum_.enum.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Enum.ts:49](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L49)*
**Returns:** `any`
___
<a id="tonumber"></a>
## toNumber
▸ **toNumber**(): `number`
*Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)*
*Defined in [codec/Enum.ts:57](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L57)*
**Returns:** `number`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Enum](_codec_enum_.enum.md).[toString](_codec_enum_.enum.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Enum.ts:61](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L61)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Enum](_codec_enum_.enum.md).[toU8a](_codec_enum_.enum.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Enum.ts:53](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Enum.ts#L53)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
docs/types/classes/_metadata_.storagefunctiontype.md
+232
View File
@@ -0,0 +1,232 @@
# Hierarchy
↳ [EnumType](_codec_enumtype_.enumtype.md)< [Type](_type_.type.md) &#124; [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)>
**↳ StorageFunctionType**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new StorageFunctionType**(index?: * `undefined` &#124; `number`*, value?: *`any`*): [StorageFunctionType](_metadata_.storagefunctiontype.md)
*Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)*
*Defined in [Metadata.ts:180](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L180)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` index | `undefined` &#124; `number`|
| `Optional` value | `any` |
**Returns:** [StorageFunctionType](_metadata_.storagefunctiontype.md)
___
# Properties
<a id="raw"></a>
## raw
**● raw**: *[Base](_codec_base_.base.md)< [Type](_type_.type.md) &#124; [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)>*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `string`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[Type](_codec_enumtype_.enumtype.md#type)*
*Defined in [codec/EnumType.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L40)*
**Returns:** `string`
___
<a id="asmap"></a>
## asMap
getasMap(): [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)
*Defined in [Metadata.ts:192](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L192)*
**Returns:** [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)
___
<a id="astype"></a>
## asType
getasType(): [Type](_type_.type.md)
*Defined in [Metadata.ts:196](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L196)*
**Returns:** [Type](_type_.type.md)
___
<a id="ismap"></a>
## isMap
getisMap(): `boolean`
*Defined in [Metadata.ts:188](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L188)*
**Returns:** `boolean`
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[byteLength](_codec_enumtype_.enumtype.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/EnumType.ts:44](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L44)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Base](_codec_base_.base.md)<[Base](_codec_base_.base.md)< [Type](_type_.type.md) &#124; [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)>>
*Inherited from [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Base.ts:29](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L29)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Base](_codec_base_.base.md)<[Base](_codec_base_.base.md)< [Type](_type_.type.md) &#124; [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)>>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [EnumType](_codec_enumtype_.enumtype.md)< [Type](_type_.type.md) &#124; [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)>
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[fromU8a](_codec_enumtype_.enumtype.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/EnumType.ts:48](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L48)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [EnumType](_codec_enumtype_.enumtype.md)< [Type](_type_.type.md) &#124; [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)>
___
<a id="setvalue"></a>
## setValue
▸ **setValue**(index?: * [EnumType](_codec_enumtype_.enumtype.md)< [Type](_type_.type.md) &#124; [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)> &#124; `number`*, value?: *`any`*): `void`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[setValue](_codec_enumtype_.enumtype.md#setvalue)*
*Defined in [codec/EnumType.ts:55](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L55)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` index | [EnumType](_codec_enumtype_.enumtype.md)< [Type](_type_.type.md) &#124; [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)> &#124; `number`|
| `Optional` value | `any` |
**Returns:** `void`
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/EnumType.ts:72](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L72)*
**Returns:** `any`
___
<a id="tonumber"></a>
## toNumber
▸ **toNumber**(): `number`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)*
*Defined in [codec/EnumType.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/EnumType.ts#L76)*
**Returns:** `number`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Overrides [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)*
*Defined in [Metadata.ts:200](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L200)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Base.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L45)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
docs/types/classes/_metadata_.storagefunctiontype_map.md
+313
View File
@@ -0,0 +1,313 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
↳ [Struct](_codec_struct_.struct.md)
**↳ StorageFunctionType$Map**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new StorageFunctionType$Map**(value?: *`any`*): [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Metadata.ts:163](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L163)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | `any` |
**Returns:** [StorageFunctionType$Map](_metadata_.storagefunctiontype_map.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)*
*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="key"></a>
## key
getkey(): [Type](_type_.type.md)
*Defined in [Metadata.ts:171](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L171)*
**Returns:** [Type](_type_.type.md)
___
<a id="value"></a>
## value
getvalue(): [Type](_type_.type.md)
*Defined in [Metadata.ts:175](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L175)*
**Returns:** [Type](_type_.type.md)
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** [Base](_codec_base_.base.md)
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)*
*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/types/classes/_metadata_.storagemetadata.md
+313
View File
@@ -0,0 +1,313 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
↳ [Struct](_codec_struct_.struct.md)
**↳ StorageMetadata**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new StorageMetadata**(value?: *`any`*): [StorageMetadata](_metadata_.storagemetadata.md)
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Metadata.ts:241](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L241)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | `any` |
**Returns:** [StorageMetadata](_metadata_.storagemetadata.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)*
*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="functions"></a>
## functions
getfunctions(): [Vector](_codec_vector_.vector.md)<[StorageFunctionMetadata](_metadata_.storagefunctionmetadata.md)>
*Defined in [Metadata.ts:249](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L249)*
**Returns:** [Vector](_codec_vector_.vector.md)<[StorageFunctionMetadata](_metadata_.storagefunctionmetadata.md)>
___
<a id="prefix"></a>
## prefix
getprefix(): [Text](_text_.text.md)
*Defined in [Metadata.ts:253](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/Metadata.ts#L253)*
**Returns:** [Text](_text_.text.md)
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** [Base](_codec_base_.base.md)
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)*
*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___
docs/types/classes/_misbehaviorreport_.bftatreport.md
+328
View File
@@ -0,0 +1,328 @@
# Type parameters
#### S
#### T
#### V
#### E
# Hierarchy
↳ [Struct](_codec_struct_.struct.md)
**↳ BftAtReport**
↳ [BftDoublePrepare](_misbehaviorreport_.bftdoubleprepare.md)
↳ [BftDoubleCommit](_misbehaviorreport_.bftdoublecommit.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new BftAtReport**(value?: *`BftAtReportValue`*): [BftAtReport](_misbehaviorreport_.bftatreport.md)
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [MisbehaviorReport.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/MisbehaviorReport.ts#L27)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` value | `BftAtReportValue` |
**Returns:** [BftAtReport](_misbehaviorreport_.bftatreport.md)
___
# Properties
<a id="_types"></a>
## `<Protected>` _Types
**● _Types**: *`E`*
*Inherited from [Struct](_codec_struct_.struct.md).[_Types](_codec_struct_.struct.md#_types)*
*Defined in [codec/Struct.ts:27](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L27)*
___
<a id="_jsonmap"></a>
## `<Protected>` _jsonMap
**● _jsonMap**: *`Map`<`keyof S`, `string`>*
*Inherited from [Struct](_codec_struct_.struct.md).[_jsonMap](_codec_struct_.struct.md#_jsonmap)*
*Defined in [codec/Struct.ts:26](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L26)*
___
<a id="raw"></a>
## raw
**● raw**: *`T`*
*Inherited from [Base](_codec_base_.base.md).[raw](_codec_base_.base.md#raw)*
*Defined in [codec/Base.ts:19](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Base.ts#L19)*
___
# Accessors
<a id="type"></a>
## Type
getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:76](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L76)*
**Returns:** `E`
___
<a id="a"></a>
## a
geta(): [BftHashSignature](_bft_.bfthashsignature.md)
*Defined in [MisbehaviorReport.ts:36](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/MisbehaviorReport.ts#L36)*
**Returns:** [BftHashSignature](_bft_.bfthashsignature.md)
___
<a id="b"></a>
## b
getb(): [BftHashSignature](_bft_.bfthashsignature.md)
*Defined in [MisbehaviorReport.ts:40](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/MisbehaviorReport.ts#L40)*
**Returns:** [BftHashSignature](_bft_.bfthashsignature.md)
___
<a id="round"></a>
## round
getround(): [U32](_u32_.u32.md)
*Defined in [MisbehaviorReport.ts:44](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/MisbehaviorReport.ts#L44)*
**Returns:** [U32](_u32_.u32.md)
___
# Methods
<a id="bytelength"></a>
## byteLength
▸ **byteLength**(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[byteLength](_codec_struct_.struct.md#bytelength)*
*Overrides [Base](_codec_base_.base.md).[byteLength](_codec_base_.base.md#bytelength)*
*Defined in [codec/Struct.ts:80](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L80)*
**Returns:** `number`
___
<a id="fromjson"></a>
## fromJSON
▸ **fromJSON**(input: *`any`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromJSON](_codec_struct_.struct.md#fromjson)*
*Overrides [Base](_codec_base_.base.md).[fromJSON](_codec_base_.base.md#fromjson)*
*Defined in [codec/Struct.ts:86](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L86)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `any` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="fromu8a"></a>
## fromU8a
▸ **fromU8a**(input: *`Uint8Array`*): [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
*Inherited from [Struct](_codec_struct_.struct.md).[fromU8a](_codec_struct_.struct.md#fromu8a)*
*Overrides [Base](_codec_base_.base.md).[fromU8a](_codec_base_.base.md#fromu8a)*
*Defined in [codec/Struct.ts:101](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L101)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| input | `Uint8Array` |
**Returns:** [Struct](_codec_struct_.struct.md)<`S`, `T`, `V`, `E`>
___
<a id="get"></a>
## get
▸ **get**(index: *`number`*): [Base](_codec_base_.base.md)
*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)*
*Defined in [codec/Struct.ts:111](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L111)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| index | `number` |
**Returns:** [Base](_codec_base_.base.md)
___
<a id="keys"></a>
## keys
▸ **keys**(): `Array`<`string`>
*Inherited from [Struct](_codec_struct_.struct.md).[keys](_codec_struct_.struct.md#keys)*
*Defined in [codec/Struct.ts:126](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L126)*
**Returns:** `Array`<`string`>
___
<a id="tojson"></a>
## toJSON
▸ **toJSON**(): `any`
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Overrides [Base](_codec_base_.base.md).[toJSON](_codec_base_.base.md#tojson)*
*Defined in [codec/Struct.ts:115](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L115)*
**Returns:** `any`
___
<a id="tostring"></a>
## toString
▸ **toString**(): `string`
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Overrides [Base](_codec_base_.base.md).[toString](_codec_base_.base.md#tostring)*
*Defined in [codec/Struct.ts:138](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L138)*
**Returns:** `string`
___
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Overrides [Base](_codec_base_.base.md).[toU8a](_codec_base_.base.md#tou8a)*
*Defined in [codec/Struct.ts:130](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L130)*
**Parameters:**
| Param | Type |
| ------ | ------ |
| `Optional` isBare | `undefined` &#124; `false` &#124; `true`|
**Returns:** `Uint8Array`
___
<a id="values"></a>
## values
▸ **values**(): `Array`<[Base](_codec_base_.base.md)>
*Inherited from [Struct](_codec_struct_.struct.md).[values](_codec_struct_.struct.md#values)*
*Defined in [codec/Struct.ts:147](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L147)*
**Returns:** `Array`<[Base](_codec_base_.base.md)>
___
<a id="decode"></a>
## `<Static>` decode
▸ **decode**<`S`,`V`,`T`>(Types: *`S`*, value: * `V` &#124; `Array`<`any`>*, isTuple: *`boolean`*): `T`
*Inherited from [Struct](_codec_struct_.struct.md).[decode](_codec_struct_.struct.md#decode)*
*Defined in [codec/Struct.ts:45](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L45)*
**Type parameters:**
#### S
#### V
#### T
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
| value | `V` &#124; `Array`<`any`>|
| isTuple | `boolean` |
**Returns:** `T`
___
<a id="with"></a>
## `<Static>` with
▸ **with**<`S`>(Types: *`S`*): `object`
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:66](https://github.com/polkadot-js/api/blob/48e57f9/packages/types/src/codec/Struct.ts#L66)*
**Type parameters:**
#### S
**Parameters:**
| Param | Type |
| ------ | ------ |
| Types | `S` |
**Returns:** `object`
___

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