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

[CI Skip] 0.41.1

Browse Source
This commit is contained in:
Travis CI
2019-01-26 15:32:47 +00:00
parent fd93fbc4a6
commit d482c3a917
412 changed files with 5239 additions and 3564 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/types/classes/_accountid_.accountid.html
+13 -13
View File
@@ -2152,7 +2152,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new AccountId</strong>(value?: <em><a href="../modules/_types_.md#anyu8a">AnyU8a</a></em>): <a href="_accountid_.accountid.html">AccountId</a></p>
<p><em>Overrides <a href="_codec_u8afixed_.u8afixed.html">U8aFixed</a>.<a href="_codec_u8afixed_.u8afixed.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountId.ts#L19" target="_blank">AccountId.ts:19</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountId.ts#L19" target="_blank">AccountId.ts:19</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2177,7 +2177,7 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2185,7 +2185,7 @@
<h2 id="isempty">isEmpty</h2>
<p>getisEmpty(): <code>boolean</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#isempty">isEmpty</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em><strong>description</strong></em>: Returns true if the type wraps an empty/default all-0 value</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
@@ -2194,7 +2194,7 @@
<p>getlength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#length">length</a></em></p>
<p><em>Overrides Uint8Array.length</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50" target="_blank">codec/U8a.ts:50</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50" target="_blank">codec/U8a.ts:50</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2203,7 +2203,7 @@
<h2 id="bitlength">bitLength</h2>
<p>&#x25B8; <strong>bitLength</strong>(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8afixed_.u8afixed.html">U8aFixed</a>.<a href="_codec_u8afixed_.u8afixed.html#bitlength">bitLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8aFixed.ts#L52" target="_blank">codec/U8aFixed.ts:52</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8aFixed.ts#L52" target="_blank">codec/U8aFixed.ts:52</a></em></p>
<p><em><strong>description</strong></em>: Returns the number of bits in the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2212,7 +2212,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Overrides <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountId.ts#L46" target="_blank">AccountId.ts:46</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountId.ts#L46" target="_blank">AccountId.ts:46</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2236,7 +2236,7 @@
<p>&#x25B8; <strong>subarray</strong>(begin: <em><code>number</code></em>, end?: <em><code>undefined</code> | <code>number</code></em>): <code>Uint8Array</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#subarray">subarray</a></em></p>
<p><em>Overrides Uint8Array.subarray</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73" target="_blank">codec/U8a.ts:73</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73" target="_blank">codec/U8a.ts:73</a></em></p>
<p><em><strong>description</strong></em>: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2268,7 +2268,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80" target="_blank">codec/U8a.ts:80</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80" target="_blank">codec/U8a.ts:80</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2277,7 +2277,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Overrides <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountId.ts#L53" target="_blank">AccountId.ts:53</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountId.ts#L53" target="_blank">AccountId.ts:53</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2286,7 +2286,7 @@
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Overrides <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountId.ts#L60" target="_blank">AccountId.ts:60</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountId.ts#L60" target="_blank">AccountId.ts:60</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2295,7 +2295,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L102" target="_blank">codec/U8a.ts:102</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L102" target="_blank">codec/U8a.ts:102</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2321,7 +2321,7 @@
<p><a id="encode"></a></p>
<h2 id="static-encode"><code>&lt;Static&gt;</code> encode</h2>
<p>&#x25B8; <strong>encode</strong>(value: <em><code>Uint8Array</code></em>): <code>string</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountId.ts#L27" target="_blank">AccountId.ts:27</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountId.ts#L27" target="_blank">AccountId.ts:27</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2382,7 +2382,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.1","depth":1,"next":{"title":"hidden","level":"4.2","depth":1,"path":"types/classes/_accountindex_.accountindex.md","ref":"types/classes/_accountindex_.accountindex.md","articles":[]},"previous":{"title":"Upgrade via sudo","level":"3.2.9","depth":2,"path":"examples/rx/10_upgrade_chain/README.md","ref":"examples/rx/10_upgrade_chain/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_accountid_.accountid.md","mtime":"2019-01-25T10:38:52.588Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.1","depth":1,"next":{"title":"hidden","level":"4.2","depth":1,"path":"types/classes/_accountindex_.accountindex.md","ref":"types/classes/_accountindex_.accountindex.md","articles":[]},"previous":{"title":"Upgrade via sudo","level":"3.2.9","depth":2,"path":"examples/rx/10_upgrade_chain/README.md","ref":"examples/rx/10_upgrade_chain/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_accountid_.accountid.md","mtime":"2019-01-26T15:31:23.477Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_accountid_.accountid.md
+12 -12
View File
@@ -29,7 +29,7 @@
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountId.ts#L19)*
*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountId.ts#L19)*
**Parameters:**
@@ -51,7 +51,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -66,7 +66,7 @@ getisEmpty(): `boolean`
*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43)*
*__description__*: Returns true if the type wraps an empty/default all-0 value
@@ -83,7 +83,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50)*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50)*
*__description__*: The length of the value
@@ -101,7 +101,7 @@ ___
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8aFixed.ts#L52)*
*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8aFixed.ts#L52)*
*__description__*: Returns the number of bits in the value
@@ -118,7 +118,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)*
*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountId.ts#L46)*
*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountId.ts#L46)*
*__description__*: Compares the value of the input to see if there is a match
@@ -141,7 +141,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73)*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -165,7 +165,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80)*
*__description__*: Returns a hex string representation of the value
@@ -182,7 +182,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountId.ts#L53)*
*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountId.ts#L53)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -199,7 +199,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountId.ts#L60)*
*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountId.ts#L60)*
*__description__*: Returns the string representation of the value
@@ -216,7 +216,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L102)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L102)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -235,7 +235,7 @@ ___
▸ **encode**(value: *`Uint8Array`*): `string`
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountId.ts#L27)*
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountId.ts#L27)*
**Parameters:**
docs/types/classes/_accountindex_.accountindex.html
+11 -11
View File
@@ -2149,7 +2149,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new AccountIndex</strong>(value?: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>): <a href="_accountindex_.accountindex.html">AccountIndex</a></p>
<p><em>Overrides <a href="_u32_.u32.html">U32</a>.<a href="_u32_.u32.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountIndex.ts#L28" target="_blank">AccountIndex.ts:28</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountIndex.ts#L28" target="_blank">AccountIndex.ts:28</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2175,7 +2175,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Overrides AbstractInt.eq</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountIndex.ts#L87" target="_blank">AccountIndex.ts:87</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountIndex.ts#L87" target="_blank">AccountIndex.ts:87</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2200,7 +2200,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tohex">toHex</a></em></p>
<p><em>Overrides AbstractInt.toHex</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/UInt.ts#L36" target="_blank">codec/UInt.ts:36</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/UInt.ts#L36" target="_blank">codec/UInt.ts:36</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2209,7 +2209,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Overrides AbstractInt.toJSON</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountIndex.ts#L100" target="_blank">AccountIndex.ts:100</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountIndex.ts#L100" target="_blank">AccountIndex.ts:100</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2218,7 +2218,7 @@
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Overrides AbstractInt.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountIndex.ts#L107" target="_blank">AccountIndex.ts:107</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountIndex.ts#L107" target="_blank">AccountIndex.ts:107</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2228,7 +2228,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tou8a">toU8a</a></em></p>
<p><em>Overrides AbstractInt.toU8a</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/UInt.ts#L48" target="_blank">codec/UInt.ts:48</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/UInt.ts#L48" target="_blank">codec/UInt.ts:48</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2254,7 +2254,7 @@
<p><a id="calclength"></a></p>
<h2 id="static-calclength"><code>&lt;Static&gt;</code> calcLength</h2>
<p>&#x25B8; <strong>calcLength</strong>(_value: <em><code>BN</code> | <code>number</code></em>): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountIndex.ts#L47" target="_blank">AccountIndex.ts:47</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountIndex.ts#L47" target="_blank">AccountIndex.ts:47</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2276,7 +2276,7 @@
<p><a id="decodeaccountindex"></a></p>
<h2 id="static-decodeaccountindex"><code>&lt;Static&gt;</code> decodeAccountIndex</h2>
<p>&#x25B8; <strong>decodeAccountIndex</strong>(value: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>): <code>BN</code> | <code>Uint8Array</code> | <code>number</code> | <code>string</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountIndex.ts#L35" target="_blank">AccountIndex.ts:35</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountIndex.ts#L35" target="_blank">AccountIndex.ts:35</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2297,7 +2297,7 @@
<p><a id="readlength"></a></p>
<h2 id="static-readlength"><code>&lt;Static&gt;</code> readLength</h2>
<p>&#x25B8; <strong>readLength</strong>(input: <em><code>Uint8Array</code></em>): [<code>number</code>, <code>number</code>]</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountIndex.ts#L61" target="_blank">AccountIndex.ts:61</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountIndex.ts#L61" target="_blank">AccountIndex.ts:61</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2318,7 +2318,7 @@
<p><a id="writelength"></a></p>
<h2 id="static-writelength"><code>&lt;Static&gt;</code> writeLength</h2>
<p>&#x25B8; <strong>writeLength</strong>(input: <em><code>Uint8Array</code></em>): <code>Uint8Array</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountIndex.ts#L75" target="_blank">AccountIndex.ts:75</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountIndex.ts#L75" target="_blank">AccountIndex.ts:75</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2379,7 +2379,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.2","depth":1,"next":{"title":"hidden","level":"4.3","depth":1,"path":"types/classes/_address_.address.md","ref":"types/classes/_address_.address.md","articles":[]},"previous":{"title":"hidden","level":"4.1","depth":1,"path":"types/classes/_accountid_.accountid.md","ref":"types/classes/_accountid_.accountid.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_accountindex_.accountindex.md","mtime":"2019-01-25T10:38:52.612Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.2","depth":1,"next":{"title":"hidden","level":"4.3","depth":1,"path":"types/classes/_address_.address.md","ref":"types/classes/_address_.address.md","articles":[]},"previous":{"title":"hidden","level":"4.1","depth":1,"path":"types/classes/_accountid_.accountid.md","ref":"types/classes/_accountid_.accountid.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_accountindex_.accountindex.md","mtime":"2019-01-26T15:31:23.501Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_accountindex_.accountindex.md
+10 -10
View File
@@ -24,7 +24,7 @@
*Overrides [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)*
*Defined in [AccountIndex.ts:28](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountIndex.ts#L28)*
*Defined in [AccountIndex.ts:28](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountIndex.ts#L28)*
**Parameters:**
@@ -48,7 +48,7 @@ ___
*Overrides AbstractInt.eq*
*Defined in [AccountIndex.ts:87](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountIndex.ts#L87)*
*Defined in [AccountIndex.ts:87](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountIndex.ts#L87)*
*__description__*: Compares the value of the input to see if there is a match
@@ -73,7 +73,7 @@ ___
*Overrides AbstractInt.toHex*
*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/UInt.ts#L36)*
*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/UInt.ts#L36)*
*__description__*: Returns a hex string representation of the value
@@ -90,7 +90,7 @@ ___
*Overrides AbstractInt.toJSON*
*Defined in [AccountIndex.ts:100](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountIndex.ts#L100)*
*Defined in [AccountIndex.ts:100](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountIndex.ts#L100)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -107,7 +107,7 @@ ___
*Overrides AbstractInt.toString*
*Defined in [AccountIndex.ts:107](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountIndex.ts#L107)*
*Defined in [AccountIndex.ts:107](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountIndex.ts#L107)*
*__description__*: Returns the string representation of the value
@@ -126,7 +126,7 @@ ___
*Overrides AbstractInt.toU8a*
*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/UInt.ts#L48)*
*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/UInt.ts#L48)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -145,7 +145,7 @@ ___
▸ **calcLength**(_value: *`BN` | `number`*): `number`
*Defined in [AccountIndex.ts:47](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountIndex.ts#L47)*
*Defined in [AccountIndex.ts:47](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountIndex.ts#L47)*
**Parameters:**
@@ -162,7 +162,7 @@ ___
▸ **decodeAccountIndex**(value: *[AnyNumber](../modules/_types_.md#anynumber)*): `BN` | `Uint8Array` | `number` | `string`
*Defined in [AccountIndex.ts:35](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountIndex.ts#L35)*
*Defined in [AccountIndex.ts:35](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountIndex.ts#L35)*
**Parameters:**
@@ -179,7 +179,7 @@ ___
▸ **readLength**(input: *`Uint8Array`*): [`number`, `number`]
*Defined in [AccountIndex.ts:61](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountIndex.ts#L61)*
*Defined in [AccountIndex.ts:61](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountIndex.ts#L61)*
**Parameters:**
@@ -196,7 +196,7 @@ ___
▸ **writeLength**(input: *`Uint8Array`*): `Uint8Array`
*Defined in [AccountIndex.ts:75](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountIndex.ts#L75)*
*Defined in [AccountIndex.ts:75](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountIndex.ts#L75)*
**Parameters:**
docs/types/classes/_address_.address.html
+10 -10
View File
@@ -2145,7 +2145,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Address</strong>(value?: <em><code>AnyAddress</code></em>): <a href="_address_.address.html">Address</a></p>
<p><em>Overrides <a href="_codec_base_.base.html">Base</a>.<a href="_codec_base_.base.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Address.ts#L25" target="_blank">Address.ts:25</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Address.ts#L25" target="_blank">Address.ts:25</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2169,14 +2169,14 @@
<p><a id="encodedlength"></a></p>
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Address.ts#L67" target="_blank">Address.ts:67</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Address.ts#L67" target="_blank">Address.ts:67</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="rawlength"></a></p>
<h2 id="rawlength">rawLength</h2>
<p>getrawLength(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Address.ts#L81" target="_blank">Address.ts:81</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Address.ts#L81" target="_blank">Address.ts:81</a></em></p>
<p><em><strong>description</strong></em>: The length of the raw value, either AccountIndex or AccountId</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2184,7 +2184,7 @@
<p><a id="eq"></a></p>
<h2 id="eq">eq</h2>
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Address.ts#L90" target="_blank">Address.ts:90</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Address.ts#L90" target="_blank">Address.ts:90</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2206,28 +2206,28 @@
<p><a id="tohex"></a></p>
<h2 id="tohex">toHex</h2>
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Address.ts#L97" target="_blank">Address.ts:97</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Address.ts#L97" target="_blank">Address.ts:97</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
<p><a id="tojson"></a></p>
<h2 id="tojson">toJSON</h2>
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Address.ts#L104" target="_blank">Address.ts:104</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Address.ts#L104" target="_blank">Address.ts:104</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
<p><a id="tostring"></a></p>
<h2 id="tostring">toString</h2>
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Address.ts#L111" target="_blank">Address.ts:111</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Address.ts#L111" target="_blank">Address.ts:111</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
<p><a id="tou8a"></a></p>
<h2 id="tou8a">toU8a</h2>
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Address.ts#L119" target="_blank">Address.ts:119</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Address.ts#L119" target="_blank">Address.ts:119</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2253,7 +2253,7 @@
<p><a id="decodeaddress"></a></p>
<h2 id="static-decodeaddress"><code>&lt;Static&gt;</code> decodeAddress</h2>
<p>&#x25B8; <strong>decodeAddress</strong>(value: <em><code>AnyAddress</code></em>): <a href="_accountid_.accountid.html">AccountId</a> | <a href="_accountindex_.accountindex.html">AccountIndex</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Address.ts#L32" target="_blank">Address.ts:32</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Address.ts#L32" target="_blank">Address.ts:32</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2314,7 +2314,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.3","depth":1,"next":{"title":"hidden","level":"4.4","depth":1,"path":"types/classes/_authorityid_.authorityid.md","ref":"types/classes/_authorityid_.authorityid.md","articles":[]},"previous":{"title":"hidden","level":"4.2","depth":1,"path":"types/classes/_accountindex_.accountindex.md","ref":"types/classes/_accountindex_.accountindex.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_address_.address.md","mtime":"2019-01-25T10:38:52.640Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.3","depth":1,"next":{"title":"hidden","level":"4.4","depth":1,"path":"types/classes/_authorityid_.authorityid.md","ref":"types/classes/_authorityid_.authorityid.md","articles":[]},"previous":{"title":"hidden","level":"4.2","depth":1,"path":"types/classes/_accountindex_.accountindex.md","ref":"types/classes/_accountindex_.accountindex.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_address_.address.md","mtime":"2019-01-26T15:31:23.537Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_address_.address.md
+9 -9
View File
@@ -20,7 +20,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [Address.ts:25](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Address.ts#L25)*
*Defined in [Address.ts:25](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Address.ts#L25)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
getencodedLength(): `number`
*Defined in [Address.ts:67](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Address.ts#L67)*
*Defined in [Address.ts:67](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Address.ts#L67)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -53,7 +53,7 @@ ___
getrawLength(): `number`
*Defined in [Address.ts:81](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Address.ts#L81)*
*Defined in [Address.ts:81](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Address.ts#L81)*
*__description__*: The length of the raw value, either AccountIndex or AccountId
@@ -69,7 +69,7 @@ ___
▸ **eq**(other?: *`any`*): `boolean`
*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Address.ts#L90)*
*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Address.ts#L90)*
*__description__*: Compares the value of the input to see if there is a match
@@ -88,7 +88,7 @@ ___
▸ **toHex**(): `string`
*Defined in [Address.ts:97](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Address.ts#L97)*
*Defined in [Address.ts:97](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Address.ts#L97)*
*__description__*: Returns a hex string representation of the value
@@ -101,7 +101,7 @@ ___
▸ **toJSON**(): `any`
*Defined in [Address.ts:104](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Address.ts#L104)*
*Defined in [Address.ts:104](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Address.ts#L104)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -114,7 +114,7 @@ ___
▸ **toString**(): `string`
*Defined in [Address.ts:111](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Address.ts#L111)*
*Defined in [Address.ts:111](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Address.ts#L111)*
*__description__*: Returns the string representation of the value
@@ -127,7 +127,7 @@ ___
▸ **toU8a**(isBare?: *`undefined` | `false` | `true`*): `Uint8Array`
*Defined in [Address.ts:119](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Address.ts#L119)*
*Defined in [Address.ts:119](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Address.ts#L119)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -146,7 +146,7 @@ ___
▸ **decodeAddress**(value: *`AnyAddress`*): [AccountId](_accountid_.accountid.md) | [AccountIndex](_accountindex_.accountindex.md)
*Defined in [Address.ts:32](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Address.ts#L32)*
*Defined in [Address.ts:32](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Address.ts#L32)*
**Parameters:**
docs/types/classes/_attestedcandidate_.attestedcandidate.md
+12 -12
View File
@@ -29,7 +29,7 @@
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [AttestedCandidate.ts:88](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AttestedCandidate.ts#L88)*
*Defined in [AttestedCandidate.ts:88](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AttestedCandidate.ts#L88)*
**Parameters:**
@@ -51,7 +51,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L142)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L142)*
*__description__*: Returns the Type description to sthe structure
@@ -66,7 +66,7 @@ getencodedLength(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L149)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L149)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -86,7 +86,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L158)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L158)*
*__description__*: Compares the value of the input to see if there is a match
@@ -109,7 +109,7 @@ ___
*Overrides Map.get*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L166)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Returns a specific names entry in the structure
@@ -130,7 +130,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L173)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L173)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -151,7 +151,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L180)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -168,7 +168,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L187)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L187)*
*__description__*: Returns a hex string representation of the value
@@ -185,7 +185,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L194)*
*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L194)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -202,7 +202,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L208)*
*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L208)*
*__description__*: Returns the string representation of the value
@@ -219,7 +219,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L216)*
*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L216)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -240,7 +240,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L122)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L122)*
**Type parameters:**
docs/types/classes/_attestedcandidate_.availabilityvote.md
+12 -12
View File
@@ -23,7 +23,7 @@
*Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L22)*
*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L22)*
**Parameters:**
@@ -46,7 +46,7 @@ getTypes(): `Array`<`string`>
*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)*
*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L68)*
*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L68)*
*__description__*: The types definition of the tuple
@@ -61,7 +61,7 @@ getencodedLength(): `number`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)*
*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L59)*
*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L59)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -81,7 +81,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)*
*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L77)*
*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L77)*
*__description__*: Compares the value of the input to see if there is a match
@@ -104,7 +104,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L133)*
*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L133)*
*__description__*: Filters the array with the callback
@@ -128,7 +128,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L142)*
*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L142)*
*__description__*: Maps the array with the callback
@@ -153,7 +153,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)*
*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L84)*
*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L84)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -170,7 +170,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)*
*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L91)*
*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L91)*
*__description__*: Returns a hex string representation of the value
@@ -187,7 +187,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L98)*
*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L98)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -206,7 +206,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L107)*
*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L107)*
*__description__*: Returns the string representation of the value
@@ -223,7 +223,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)*
*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L116)*
*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L116)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -244,7 +244,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L48)*
*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L48)*
**Parameters:**
docs/types/classes/_attestedcandidate_.balanceupload.md
+12 -12
View File
@@ -23,7 +23,7 @@
*Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L22)*
*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L22)*
**Parameters:**
@@ -46,7 +46,7 @@ getTypes(): `Array`<`string`>
*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)*
*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L68)*
*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L68)*
*__description__*: The types definition of the tuple
@@ -61,7 +61,7 @@ getencodedLength(): `number`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)*
*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L59)*
*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L59)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -81,7 +81,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)*
*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L77)*
*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L77)*
*__description__*: Compares the value of the input to see if there is a match
@@ -104,7 +104,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L133)*
*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L133)*
*__description__*: Filters the array with the callback
@@ -128,7 +128,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L142)*
*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L142)*
*__description__*: Maps the array with the callback
@@ -153,7 +153,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)*
*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L84)*
*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L84)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -170,7 +170,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)*
*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L91)*
*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L91)*
*__description__*: Returns a hex string representation of the value
@@ -187,7 +187,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L98)*
*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L98)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -206,7 +206,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L107)*
*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L107)*
*__description__*: Returns the string representation of the value
@@ -223,7 +223,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)*
*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L116)*
*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L116)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -244,7 +244,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L48)*
*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L48)*
**Parameters:**
docs/types/classes/_attestedcandidate_.candidatereceipt.md
+12 -12
View File
@@ -25,7 +25,7 @@
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [AttestedCandidate.ts:30](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AttestedCandidate.ts#L30)*
*Defined in [AttestedCandidate.ts:30](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AttestedCandidate.ts#L30)*
**Parameters:**
@@ -47,7 +47,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L142)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L142)*
*__description__*: Returns the Type description to sthe structure
@@ -62,7 +62,7 @@ getencodedLength(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L149)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L149)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -82,7 +82,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L158)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L158)*
*__description__*: Compares the value of the input to see if there is a match
@@ -105,7 +105,7 @@ ___
*Overrides Map.get*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L166)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Returns a specific names entry in the structure
@@ -126,7 +126,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L173)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L173)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -147,7 +147,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L180)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -164,7 +164,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L187)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L187)*
*__description__*: Returns a hex string representation of the value
@@ -181,7 +181,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L194)*
*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L194)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -198,7 +198,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L208)*
*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L208)*
*__description__*: Returns the string representation of the value
@@ -215,7 +215,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L216)*
*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L216)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -236,7 +236,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L122)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L122)*
**Type parameters:**
docs/types/classes/_attestedcandidate_.candidatesignature.md
+11 -11
View File
@@ -29,7 +29,7 @@
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/H512.ts#L14)*
*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/H512.ts#L14)*
**Parameters:**
@@ -51,7 +51,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -66,7 +66,7 @@ getisEmpty(): `boolean`
*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43)*
*__description__*: Returns true if the type wraps an empty/default all-0 value
@@ -83,7 +83,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50)*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50)*
*__description__*: The length of the value
@@ -101,7 +101,7 @@ ___
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8aFixed.ts#L52)*
*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8aFixed.ts#L52)*
*__description__*: Returns the number of bits in the value
@@ -118,7 +118,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L58)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L58)*
*__description__*: Compares the value of the input to see if there is a match
@@ -141,7 +141,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73)*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -165,7 +165,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80)*
*__description__*: Returns a hex string representation of the value
@@ -182,7 +182,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L87)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L87)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -201,7 +201,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L94)*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L94)*
*__description__*: Returns the string representation of the value
@@ -218,7 +218,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L102)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L102)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_attestedcandidate_.egressqueueroot.md
+12 -12
View File
@@ -23,7 +23,7 @@
*Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L22)*
*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L22)*
**Parameters:**
@@ -46,7 +46,7 @@ getTypes(): `Array`<`string`>
*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)*
*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L68)*
*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L68)*
*__description__*: The types definition of the tuple
@@ -61,7 +61,7 @@ getencodedLength(): `number`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)*
*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L59)*
*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L59)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -81,7 +81,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)*
*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L77)*
*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L77)*
*__description__*: Compares the value of the input to see if there is a match
@@ -104,7 +104,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L133)*
*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L133)*
*__description__*: Filters the array with the callback
@@ -128,7 +128,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L142)*
*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L142)*
*__description__*: Maps the array with the callback
@@ -153,7 +153,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)*
*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L84)*
*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L84)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -170,7 +170,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)*
*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L91)*
*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L91)*
*__description__*: Returns a hex string representation of the value
@@ -187,7 +187,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L98)*
*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L98)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -206,7 +206,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L107)*
*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L107)*
*__description__*: Returns the string representation of the value
@@ -223,7 +223,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)*
*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L116)*
*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L116)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -244,7 +244,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L48)*
*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L48)*
**Parameters:**
docs/types/classes/_attestedcandidate_.explicitcandidatesignature.md
+11 -11
View File
@@ -25,7 +25,7 @@
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/H512.ts#L14)*
*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/H512.ts#L14)*
**Parameters:**
@@ -47,7 +47,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -62,7 +62,7 @@ getisEmpty(): `boolean`
*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43)*
*__description__*: Returns true if the type wraps an empty/default all-0 value
@@ -79,7 +79,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50)*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50)*
*__description__*: The length of the value
@@ -97,7 +97,7 @@ ___
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8aFixed.ts#L52)*
*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8aFixed.ts#L52)*
*__description__*: Returns the number of bits in the value
@@ -114,7 +114,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L58)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L58)*
*__description__*: Compares the value of the input to see if there is a match
@@ -137,7 +137,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73)*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -161,7 +161,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80)*
*__description__*: Returns a hex string representation of the value
@@ -178,7 +178,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L87)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L87)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -197,7 +197,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L94)*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L94)*
*__description__*: Returns the string representation of the value
@@ -214,7 +214,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L102)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L102)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_attestedcandidate_.headdata.md
+10 -10
View File
@@ -25,7 +25,7 @@
*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)*
*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bytes.ts#L18)*
*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bytes.ts#L18)*
**Parameters:**
@@ -49,7 +49,7 @@ getencodedLength(): `number`
*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bytes.ts#L61)*
*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bytes.ts#L61)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -64,7 +64,7 @@ getisEmpty(): `boolean`
*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43)*
*__description__*: Returns true if the type wraps an empty/default all-0 value
@@ -81,7 +81,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50)*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50)*
*__description__*: The length of the value
@@ -101,7 +101,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L58)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L58)*
*__description__*: Compares the value of the input to see if there is a match
@@ -124,7 +124,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73)*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -148,7 +148,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80)*
*__description__*: Returns a hex string representation of the value
@@ -165,7 +165,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L87)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L87)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -184,7 +184,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L94)*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L94)*
*__description__*: Returns the string representation of the value
@@ -203,7 +203,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [Bytes.ts:69](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bytes.ts#L69)*
*Defined in [Bytes.ts:69](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bytes.ts#L69)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_attestedcandidate_.implicitcandidatesignature.md
+11 -11
View File
@@ -25,7 +25,7 @@
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/H512.ts#L14)*
*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/H512.ts#L14)*
**Parameters:**
@@ -47,7 +47,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -62,7 +62,7 @@ getisEmpty(): `boolean`
*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43)*
*__description__*: Returns true if the type wraps an empty/default all-0 value
@@ -79,7 +79,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50)*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50)*
*__description__*: The length of the value
@@ -97,7 +97,7 @@ ___
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8aFixed.ts#L52)*
*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8aFixed.ts#L52)*
*__description__*: Returns the number of bits in the value
@@ -114,7 +114,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L58)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L58)*
*__description__*: Compares the value of the input to see if there is a match
@@ -137,7 +137,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73)*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -161,7 +161,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80)*
*__description__*: Returns a hex string representation of the value
@@ -178,7 +178,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L87)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L87)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -197,7 +197,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L94)*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L94)*
*__description__*: Returns the string representation of the value
@@ -214,7 +214,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L102)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L102)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_attestedcandidate_.validityattestation.md
+29 -14
View File
@@ -20,7 +20,7 @@
*Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)*
*Defined in [AttestedCandidate.ts:54](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AttestedCandidate.ts#L54)*
*Defined in [AttestedCandidate.ts:54](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AttestedCandidate.ts#L54)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
getasExplicitCandidateSignature(): [ExplicitCandidateSignature](_attestedcandidate_.explicitcandidatesignature.md)
*Defined in [AttestedCandidate.ts:68](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AttestedCandidate.ts#L68)*
*Defined in [AttestedCandidate.ts:68](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AttestedCandidate.ts#L68)*
*__description__*: Returns the item as a [ExplicitCandidateSignature](_attestedcandidate_.explicitcandidatesignature.md)
@@ -53,7 +53,7 @@ ___
getasImplicitCandidateSignature(): [ImplicitCandidateSignature](_attestedcandidate_.implicitcandidatesignature.md)
*Defined in [AttestedCandidate.ts:75](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AttestedCandidate.ts#L75)*
*Defined in [AttestedCandidate.ts:75](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AttestedCandidate.ts#L75)*
*__description__*: Returns the item as a [ImplicitCandidateSignature](_attestedcandidate_.implicitcandidatesignature.md)
@@ -68,12 +68,27 @@ getencodedLength(): `number`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)*
*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L101)*
*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L101)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
___
<a id="index"></a>
## index
getindex(): `number`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)*
*Defined in [codec/EnumType.ts:108](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L108)*
*__description__*: The index of the metadata value
**Returns:** `number`
___
<a id="isnone"></a>
@@ -83,7 +98,7 @@ getisNone(): `boolean`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)*
*Defined in [codec/EnumType.ts:108](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L108)*
*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L115)*
*__description__*: Checks if the Enum points to a [Null](_null_.null.md) type
@@ -98,7 +113,7 @@ getisNull(): `boolean`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)*
*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L115)*
*Defined in [codec/EnumType.ts:122](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L122)*
*__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone)
@@ -113,7 +128,7 @@ gettype(): `string`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)*
*Defined in [codec/EnumType.ts:122](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L122)*
*Defined in [codec/EnumType.ts:129](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L129)*
*__description__*: The name of the type this enum value represents
@@ -128,7 +143,7 @@ getvalue(): [Codec](../interfaces/_types_.codec.md)
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)*
*Defined in [codec/EnumType.ts:129](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L129)*
*Defined in [codec/EnumType.ts:136](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L136)*
*__description__*: The value of the enum
@@ -148,7 +163,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)*
*Defined in [codec/EnumType.ts:136](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L136)*
*Defined in [codec/EnumType.ts:143](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L143)*
*__description__*: Compares the value of the input to see if there is a match
@@ -171,7 +186,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)*
*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L149)*
*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L156)*
*__description__*: Returns a hex string representation of the value
@@ -188,7 +203,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)*
*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L156)*
*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L163)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -203,7 +218,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)*
*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L163)*
*Defined in [codec/EnumType.ts:170](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L170)*
*__description__*: Returns the number representation for the value
@@ -220,7 +235,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)*
*Defined in [codec/EnumType.ts:170](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L170)*
*Defined in [codec/EnumType.ts:177](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L177)*
*__description__*: Returns the string representation of the value
@@ -237,7 +252,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)*
*Defined in [codec/EnumType.ts:178](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L178)*
*Defined in [codec/EnumType.ts:185](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L185)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_attestedcandidate_.validityvote.md
+12 -12
View File
@@ -23,7 +23,7 @@
*Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L22)*
*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L22)*
**Parameters:**
@@ -46,7 +46,7 @@ getTypes(): `Array`<`string`>
*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)*
*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L68)*
*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L68)*
*__description__*: The types definition of the tuple
@@ -61,7 +61,7 @@ getencodedLength(): `number`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)*
*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L59)*
*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L59)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -81,7 +81,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)*
*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L77)*
*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L77)*
*__description__*: Compares the value of the input to see if there is a match
@@ -104,7 +104,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L133)*
*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L133)*
*__description__*: Filters the array with the callback
@@ -128,7 +128,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L142)*
*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L142)*
*__description__*: Maps the array with the callback
@@ -153,7 +153,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)*
*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L84)*
*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L84)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -170,7 +170,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)*
*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L91)*
*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L91)*
*__description__*: Returns a hex string representation of the value
@@ -187,7 +187,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L98)*
*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L98)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -206,7 +206,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L107)*
*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L107)*
*__description__*: Returns the string representation of the value
@@ -223,7 +223,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)*
*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L116)*
*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L116)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -244,7 +244,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L48)*
*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L48)*
**Parameters:**
docs/types/classes/_authorityid_.authorityid.html
+13 -13
View File
@@ -2151,7 +2151,7 @@
<p>&#x2295; <strong>new AuthorityId</strong>(value?: <em><a href="../modules/_types_.md#anyu8a">AnyU8a</a></em>): <a href="_authorityid_.authorityid.html">AuthorityId</a></p>
<p><em>Inherited from <a href="_accountid_.accountid.html">AccountId</a>.<a href="_accountid_.accountid.html#constructor">constructor</a></em></p>
<p><em>Overrides <a href="_codec_u8afixed_.u8afixed.html">U8aFixed</a>.<a href="_codec_u8afixed_.u8afixed.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountId.ts#L19" target="_blank">AccountId.ts:19</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountId.ts#L19" target="_blank">AccountId.ts:19</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2176,7 +2176,7 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2184,7 +2184,7 @@
<h2 id="isempty">isEmpty</h2>
<p>getisEmpty(): <code>boolean</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#isempty">isEmpty</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em><strong>description</strong></em>: Returns true if the type wraps an empty/default all-0 value</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
@@ -2193,7 +2193,7 @@
<p>getlength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#length">length</a></em></p>
<p><em>Overrides Uint8Array.length</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50" target="_blank">codec/U8a.ts:50</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50" target="_blank">codec/U8a.ts:50</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2202,7 +2202,7 @@
<h2 id="bitlength">bitLength</h2>
<p>&#x25B8; <strong>bitLength</strong>(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8afixed_.u8afixed.html">U8aFixed</a>.<a href="_codec_u8afixed_.u8afixed.html#bitlength">bitLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8aFixed.ts#L52" target="_blank">codec/U8aFixed.ts:52</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8aFixed.ts#L52" target="_blank">codec/U8aFixed.ts:52</a></em></p>
<p><em><strong>description</strong></em>: Returns the number of bits in the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2212,7 +2212,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_accountid_.accountid.html">AccountId</a>.<a href="_accountid_.accountid.html#eq">eq</a></em></p>
<p><em>Overrides <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountId.ts#L46" target="_blank">AccountId.ts:46</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountId.ts#L46" target="_blank">AccountId.ts:46</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2236,7 +2236,7 @@
<p>&#x25B8; <strong>subarray</strong>(begin: <em><code>number</code></em>, end?: <em><code>undefined</code> | <code>number</code></em>): <code>Uint8Array</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#subarray">subarray</a></em></p>
<p><em>Overrides Uint8Array.subarray</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73" target="_blank">codec/U8a.ts:73</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73" target="_blank">codec/U8a.ts:73</a></em></p>
<p><em><strong>description</strong></em>: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2268,7 +2268,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80" target="_blank">codec/U8a.ts:80</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80" target="_blank">codec/U8a.ts:80</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2278,7 +2278,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_accountid_.accountid.html">AccountId</a>.<a href="_accountid_.accountid.html#tojson">toJSON</a></em></p>
<p><em>Overrides <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountId.ts#L53" target="_blank">AccountId.ts:53</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountId.ts#L53" target="_blank">AccountId.ts:53</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2288,7 +2288,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_accountid_.accountid.html">AccountId</a>.<a href="_accountid_.accountid.html#tostring">toString</a></em></p>
<p><em>Overrides <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountId.ts#L60" target="_blank">AccountId.ts:60</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountId.ts#L60" target="_blank">AccountId.ts:60</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2297,7 +2297,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L102" target="_blank">codec/U8a.ts:102</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L102" target="_blank">codec/U8a.ts:102</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2324,7 +2324,7 @@
<h2 id="static-encode"><code>&lt;Static&gt;</code> encode</h2>
<p>&#x25B8; <strong>encode</strong>(value: <em><code>Uint8Array</code></em>): <code>string</code></p>
<p><em>Inherited from <a href="_accountid_.accountid.html">AccountId</a>.<a href="_accountid_.accountid.html#encode">encode</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountId.ts#L27" target="_blank">AccountId.ts:27</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountId.ts#L27" target="_blank">AccountId.ts:27</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2385,7 +2385,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.4","depth":1,"next":{"title":"hidden","level":"4.5","depth":1,"path":"types/classes/_balance_.balance.md","ref":"types/classes/_balance_.balance.md","articles":[]},"previous":{"title":"hidden","level":"4.3","depth":1,"path":"types/classes/_address_.address.md","ref":"types/classes/_address_.address.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_authorityid_.authorityid.md","mtime":"2019-01-25T10:38:53.084Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.4","depth":1,"next":{"title":"hidden","level":"4.5","depth":1,"path":"types/classes/_balance_.balance.md","ref":"types/classes/_balance_.balance.md","articles":[]},"previous":{"title":"hidden","level":"4.3","depth":1,"path":"types/classes/_address_.address.md","ref":"types/classes/_address_.address.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_authorityid_.authorityid.md","mtime":"2019-01-26T15:31:24.013Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_authorityid_.authorityid.md
+12 -12
View File
@@ -27,7 +27,7 @@
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountId.ts#L19)*
*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountId.ts#L19)*
**Parameters:**
@@ -49,7 +49,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -64,7 +64,7 @@ getisEmpty(): `boolean`
*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43)*
*__description__*: Returns true if the type wraps an empty/default all-0 value
@@ -81,7 +81,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50)*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50)*
*__description__*: The length of the value
@@ -99,7 +99,7 @@ ___
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8aFixed.ts#L52)*
*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8aFixed.ts#L52)*
*__description__*: Returns the number of bits in the value
@@ -118,7 +118,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)*
*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountId.ts#L46)*
*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountId.ts#L46)*
*__description__*: Compares the value of the input to see if there is a match
@@ -141,7 +141,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73)*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -165,7 +165,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80)*
*__description__*: Returns a hex string representation of the value
@@ -184,7 +184,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountId.ts#L53)*
*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountId.ts#L53)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -203,7 +203,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountId.ts#L60)*
*Defined in [AccountId.ts:60](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountId.ts#L60)*
*__description__*: Returns the string representation of the value
@@ -220,7 +220,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L102)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L102)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -241,7 +241,7 @@ ___
*Inherited from [AccountId](_accountid_.accountid.md).[encode](_accountid_.accountid.md#encode)*
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/AccountId.ts#L27)*
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/AccountId.ts#L27)*
**Parameters:**
docs/types/classes/_balance_.balance.html
+4 -4
View File
@@ -2150,7 +2150,7 @@
<p>&#x2295; <strong>new Balance</strong>(value?: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>): <a href="_balance_.balance.html">Balance</a></p>
<p><em>Inherited from <a href="_u128_.u128.html">U128</a>.<a href="_u128_.u128.html#constructor">constructor</a></em></p>
<p><em>Overrides <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/U128.ts#L14" target="_blank">U128.ts:14</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/U128.ts#L14" target="_blank">U128.ts:14</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2175,7 +2175,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tohex">toHex</a></em></p>
<p><em>Overrides AbstractInt.toHex</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/UInt.ts#L36" target="_blank">codec/UInt.ts:36</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/UInt.ts#L36" target="_blank">codec/UInt.ts:36</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2185,7 +2185,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tou8a">toU8a</a></em></p>
<p><em>Overrides AbstractInt.toU8a</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/UInt.ts#L48" target="_blank">codec/UInt.ts:48</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/UInt.ts#L48" target="_blank">codec/UInt.ts:48</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2251,7 +2251,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.5","depth":1,"next":{"title":"hidden","level":"4.6","depth":1,"path":"types/classes/_bft_.bftauthoritysignature.md","ref":"types/classes/_bft_.bftauthoritysignature.md","articles":[]},"previous":{"title":"hidden","level":"4.4","depth":1,"path":"types/classes/_authorityid_.authorityid.md","ref":"types/classes/_authorityid_.authorityid.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_balance_.balance.md","mtime":"2019-01-25T10:38:53.096Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.5","depth":1,"next":{"title":"hidden","level":"4.6","depth":1,"path":"types/classes/_bft_.bftauthoritysignature.md","ref":"types/classes/_bft_.bftauthoritysignature.md","articles":[]},"previous":{"title":"hidden","level":"4.4","depth":1,"path":"types/classes/_authorityid_.authorityid.md","ref":"types/classes/_authorityid_.authorityid.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_balance_.balance.md","mtime":"2019-01-26T15:31:24.041Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_balance_.balance.md
+3 -3
View File
@@ -26,7 +26,7 @@
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/U128.ts#L14)*
*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/U128.ts#L14)*
**Parameters:**
@@ -52,7 +52,7 @@ ___
*Overrides AbstractInt.toHex*
*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/UInt.ts#L36)*
*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/UInt.ts#L36)*
*__description__*: Returns a hex string representation of the value
@@ -71,7 +71,7 @@ ___
*Overrides AbstractInt.toU8a*
*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/UInt.ts#L48)*
*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/UInt.ts#L48)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_bft_.bftauthoritysignature.html
+15 -15
View File
@@ -2151,7 +2151,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new BftAuthoritySignature</strong>(value?: <em><a href="../modules/_bft_.md#bftauthoritysignaturevalue">BftAuthoritySignatureValue</a> | <code>Uint8Array</code></em>): <a href="_bft_.bftauthoritysignature.html">BftAuthoritySignature</a></p>
<p><em>Overrides <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bft.ts#L20" target="_blank">Bft.ts:20</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bft.ts#L20" target="_blank">Bft.ts:20</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2175,14 +2175,14 @@
<h2 id="types">Types</h2>
<p>getTypes(): <code>Array</code>&lt;<code>string</code>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#types">Types</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L68" target="_blank">codec/Tuple.ts:68</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L68" target="_blank">codec/Tuple.ts:68</a></em></p>
<p><em><strong>description</strong></em>: The types definition of the tuple</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<code>string</code>&gt;</p>
<hr>
<p><a id="authorityid"></a></p>
<h2 id="authorityid">authorityId</h2>
<p>getauthorityId(): <a href="_authorityid_.authorityid.html">AuthorityId</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bft.ts#L31" target="_blank">Bft.ts:31</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bft.ts#L31" target="_blank">Bft.ts:31</a></em></p>
<p><em><strong>description</strong></em>: The wrapped [[AuthoriyId]]</p>
<p><strong>Returns:</strong> <a href="_authorityid_.authorityid.html">AuthorityId</a></p>
<hr>
@@ -2190,14 +2190,14 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L59" target="_blank">codec/Tuple.ts:59</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L59" target="_blank">codec/Tuple.ts:59</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="signature"></a></p>
<h2 id="signature">signature</h2>
<p>getsignature(): <a href="_signature_.signature.html">Signature</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bft.ts#L38" target="_blank">Bft.ts:38</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bft.ts#L38" target="_blank">Bft.ts:38</a></em></p>
<p><em><strong>description</strong></em>: The wrapped <a href="_signature_.signature.html">Signature</a> value</p>
<p><strong>Returns:</strong> <a href="_signature_.signature.html">Signature</a></p>
<hr>
@@ -2207,7 +2207,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L77" target="_blank">codec/Tuple.ts:77</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L77" target="_blank">codec/Tuple.ts:77</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2231,7 +2231,7 @@
<p>&#x25B8; <strong>filter</strong>(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#filter">filter</a></em></p>
<p><em>Overrides Array.filter</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L133" target="_blank">codec/Tuple.ts:133</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L133" target="_blank">codec/Tuple.ts:133</a></em></p>
<p><em><strong>description</strong></em>: Filters the array with the callback</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2262,7 +2262,7 @@
<p>&#x25B8; <strong>map</strong>&lt;<code>U</code>&gt;(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code>&lt;<code>U</code>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#map">map</a></em></p>
<p><em>Overrides Array.map</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L142" target="_blank">codec/Tuple.ts:142</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L142" target="_blank">codec/Tuple.ts:142</a></em></p>
<p><em><strong>description</strong></em>: Maps the array with the callback</p>
<p><strong>Type parameters:</strong></p>
<h4 id="u">U</h4>
@@ -2294,7 +2294,7 @@
<h2 id="toarray">toArray</h2>
<p>&#x25B8; <strong>toArray</strong>(): <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#toarray">toArray</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L84" target="_blank">codec/Tuple.ts:84</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L84" target="_blank">codec/Tuple.ts:84</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to an standard JavaScript Array</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<hr>
@@ -2303,7 +2303,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L91" target="_blank">codec/Tuple.ts:91</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L91" target="_blank">codec/Tuple.ts:91</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2312,7 +2312,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L98" target="_blank">codec/Tuple.ts:98</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L98" target="_blank">codec/Tuple.ts:98</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2322,7 +2322,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tostring">toString</a></em></p>
<p><em>Overrides Array.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L107" target="_blank">codec/Tuple.ts:107</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L107" target="_blank">codec/Tuple.ts:107</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2331,7 +2331,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L116" target="_blank">codec/Tuple.ts:116</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L116" target="_blank">codec/Tuple.ts:116</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2358,7 +2358,7 @@
<h2 id="static-with"><code>&lt;Static&gt;</code> with</h2>
<p>&#x25B8; <strong>with</strong>(Types: <em><code>TupleConstructors</code></em>): <a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_tuple_.tuple.html">Tuple</a>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#with">with</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L48" target="_blank">codec/Tuple.ts:48</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L48" target="_blank">codec/Tuple.ts:48</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2419,7 +2419,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.6","depth":1,"next":{"title":"hidden","level":"4.7","depth":1,"path":"types/classes/_bft_.bfthashsignature.md","ref":"types/classes/_bft_.bfthashsignature.md","articles":[]},"previous":{"title":"hidden","level":"4.5","depth":1,"path":"types/classes/_balance_.balance.md","ref":"types/classes/_balance_.balance.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_bft_.bftauthoritysignature.md","mtime":"2019-01-25T10:38:53.140Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.6","depth":1,"next":{"title":"hidden","level":"4.7","depth":1,"path":"types/classes/_bft_.bfthashsignature.md","ref":"types/classes/_bft_.bfthashsignature.md","articles":[]},"previous":{"title":"hidden","level":"4.5","depth":1,"path":"types/classes/_balance_.balance.md","ref":"types/classes/_balance_.balance.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_bft_.bftauthoritysignature.md","mtime":"2019-01-26T15:31:24.089Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_bft_.bftauthoritysignature.md
+14 -14
View File
@@ -27,7 +27,7 @@
*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [Bft.ts:20](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bft.ts#L20)*
*Defined in [Bft.ts:20](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bft.ts#L20)*
**Parameters:**
@@ -49,7 +49,7 @@ getTypes(): `Array`<`string`>
*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)*
*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L68)*
*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L68)*
*__description__*: The types definition of the tuple
@@ -62,7 +62,7 @@ ___
getauthorityId(): [AuthorityId](_authorityid_.authorityid.md)
*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bft.ts#L31)*
*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bft.ts#L31)*
*__description__*: The wrapped \[\[AuthoriyId\]\]
@@ -77,7 +77,7 @@ getencodedLength(): `number`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)*
*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L59)*
*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L59)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -90,7 +90,7 @@ ___
getsignature(): [Signature](_signature_.signature.md)
*Defined in [Bft.ts:38](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bft.ts#L38)*
*Defined in [Bft.ts:38](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bft.ts#L38)*
*__description__*: The wrapped [Signature](_signature_.signature.md) value
@@ -110,7 +110,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)*
*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L77)*
*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L77)*
*__description__*: Compares the value of the input to see if there is a match
@@ -133,7 +133,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L133)*
*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L133)*
*__description__*: Filters the array with the callback
@@ -157,7 +157,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L142)*
*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L142)*
*__description__*: Maps the array with the callback
@@ -182,7 +182,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)*
*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L84)*
*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L84)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -199,7 +199,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)*
*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L91)*
*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L91)*
*__description__*: Returns a hex string representation of the value
@@ -216,7 +216,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L98)*
*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L98)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -235,7 +235,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L107)*
*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L107)*
*__description__*: Returns the string representation of the value
@@ -252,7 +252,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)*
*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L116)*
*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L116)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -273,7 +273,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L48)*
*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L48)*
**Parameters:**
docs/types/classes/_bft_.bfthashsignature.html
+15 -15
View File
@@ -2151,7 +2151,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new BftHashSignature</strong>(value?: <em><a href="../modules/_bft_.md#bfthashsignaturevalue">BftHashSignatureValue</a> | <code>Uint8Array</code></em>): <a href="_bft_.bfthashsignature.html">BftHashSignature</a></p>
<p><em>Overrides <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bft.ts#L51" target="_blank">Bft.ts:51</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bft.ts#L51" target="_blank">Bft.ts:51</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2175,7 +2175,7 @@
<h2 id="types">Types</h2>
<p>getTypes(): <code>Array</code>&lt;<code>string</code>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#types">Types</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L68" target="_blank">codec/Tuple.ts:68</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L68" target="_blank">codec/Tuple.ts:68</a></em></p>
<p><em><strong>description</strong></em>: The types definition of the tuple</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<code>string</code>&gt;</p>
<hr>
@@ -2183,21 +2183,21 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L59" target="_blank">codec/Tuple.ts:59</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L59" target="_blank">codec/Tuple.ts:59</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="hash"></a></p>
<h2 id="hash">hash</h2>
<p>gethash(): <a href="_hash_.hash.html">Hash</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bft.ts#L62" target="_blank">Bft.ts:62</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bft.ts#L62" target="_blank">Bft.ts:62</a></em></p>
<p><em><strong>description</strong></em>: The wrapped <a href="_hash_.hash.html">Hash</a></p>
<p><strong>Returns:</strong> <a href="_hash_.hash.html">Hash</a></p>
<hr>
<p><a id="signature"></a></p>
<h2 id="signature">signature</h2>
<p>getsignature(): <a href="_signature_.signature.html">Signature</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bft.ts#L69" target="_blank">Bft.ts:69</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bft.ts#L69" target="_blank">Bft.ts:69</a></em></p>
<p><em><strong>description</strong></em>: The wrapped <a href="_signature_.signature.html">Signature</a></p>
<p><strong>Returns:</strong> <a href="_signature_.signature.html">Signature</a></p>
<hr>
@@ -2207,7 +2207,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L77" target="_blank">codec/Tuple.ts:77</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L77" target="_blank">codec/Tuple.ts:77</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2231,7 +2231,7 @@
<p>&#x25B8; <strong>filter</strong>(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#filter">filter</a></em></p>
<p><em>Overrides Array.filter</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L133" target="_blank">codec/Tuple.ts:133</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L133" target="_blank">codec/Tuple.ts:133</a></em></p>
<p><em><strong>description</strong></em>: Filters the array with the callback</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2262,7 +2262,7 @@
<p>&#x25B8; <strong>map</strong>&lt;<code>U</code>&gt;(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code>&lt;<code>U</code>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#map">map</a></em></p>
<p><em>Overrides Array.map</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L142" target="_blank">codec/Tuple.ts:142</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L142" target="_blank">codec/Tuple.ts:142</a></em></p>
<p><em><strong>description</strong></em>: Maps the array with the callback</p>
<p><strong>Type parameters:</strong></p>
<h4 id="u">U</h4>
@@ -2294,7 +2294,7 @@
<h2 id="toarray">toArray</h2>
<p>&#x25B8; <strong>toArray</strong>(): <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#toarray">toArray</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L84" target="_blank">codec/Tuple.ts:84</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L84" target="_blank">codec/Tuple.ts:84</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to an standard JavaScript Array</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<hr>
@@ -2303,7 +2303,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L91" target="_blank">codec/Tuple.ts:91</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L91" target="_blank">codec/Tuple.ts:91</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2312,7 +2312,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L98" target="_blank">codec/Tuple.ts:98</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L98" target="_blank">codec/Tuple.ts:98</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2322,7 +2322,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tostring">toString</a></em></p>
<p><em>Overrides Array.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L107" target="_blank">codec/Tuple.ts:107</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L107" target="_blank">codec/Tuple.ts:107</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2331,7 +2331,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L116" target="_blank">codec/Tuple.ts:116</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L116" target="_blank">codec/Tuple.ts:116</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2358,7 +2358,7 @@
<h2 id="static-with"><code>&lt;Static&gt;</code> with</h2>
<p>&#x25B8; <strong>with</strong>(Types: <em><code>TupleConstructors</code></em>): <a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_tuple_.tuple.html">Tuple</a>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#with">with</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L48" target="_blank">codec/Tuple.ts:48</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L48" target="_blank">codec/Tuple.ts:48</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2419,7 +2419,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.7","depth":1,"next":{"title":"hidden","level":"4.8","depth":1,"path":"types/classes/_block_.block.md","ref":"types/classes/_block_.block.md","articles":[]},"previous":{"title":"hidden","level":"4.6","depth":1,"path":"types/classes/_bft_.bftauthoritysignature.md","ref":"types/classes/_bft_.bftauthoritysignature.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_bft_.bfthashsignature.md","mtime":"2019-01-25T10:38:53.188Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.7","depth":1,"next":{"title":"hidden","level":"4.8","depth":1,"path":"types/classes/_block_.block.md","ref":"types/classes/_block_.block.md","articles":[]},"previous":{"title":"hidden","level":"4.6","depth":1,"path":"types/classes/_bft_.bftauthoritysignature.md","ref":"types/classes/_bft_.bftauthoritysignature.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_bft_.bfthashsignature.md","mtime":"2019-01-26T15:31:24.141Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_bft_.bfthashsignature.md
+14 -14
View File
@@ -27,7 +27,7 @@
*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [Bft.ts:51](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bft.ts#L51)*
*Defined in [Bft.ts:51](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bft.ts#L51)*
**Parameters:**
@@ -49,7 +49,7 @@ getTypes(): `Array`<`string`>
*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)*
*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L68)*
*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L68)*
*__description__*: The types definition of the tuple
@@ -64,7 +64,7 @@ getencodedLength(): `number`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)*
*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L59)*
*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L59)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -77,7 +77,7 @@ ___
gethash(): [Hash](_hash_.hash.md)
*Defined in [Bft.ts:62](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bft.ts#L62)*
*Defined in [Bft.ts:62](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bft.ts#L62)*
*__description__*: The wrapped [Hash](_hash_.hash.md)
@@ -90,7 +90,7 @@ ___
getsignature(): [Signature](_signature_.signature.md)
*Defined in [Bft.ts:69](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bft.ts#L69)*
*Defined in [Bft.ts:69](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bft.ts#L69)*
*__description__*: The wrapped [Signature](_signature_.signature.md)
@@ -110,7 +110,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)*
*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L77)*
*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L77)*
*__description__*: Compares the value of the input to see if there is a match
@@ -133,7 +133,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L133)*
*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L133)*
*__description__*: Filters the array with the callback
@@ -157,7 +157,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L142)*
*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L142)*
*__description__*: Maps the array with the callback
@@ -182,7 +182,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)*
*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L84)*
*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L84)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -199,7 +199,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)*
*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L91)*
*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L91)*
*__description__*: Returns a hex string representation of the value
@@ -216,7 +216,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L98)*
*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L98)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -235,7 +235,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L107)*
*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L107)*
*__description__*: Returns the string representation of the value
@@ -252,7 +252,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)*
*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L116)*
*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L116)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -273,7 +273,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L48)*
*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L48)*
**Parameters:**
docs/types/classes/_block_.block.html
+17 -17
View File
@@ -2154,7 +2154,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Block</strong>(value?: <em><a href="../modules/_block_.md#blockvalue">BlockValue</a> | <code>Uint8Array</code></em>): <a href="_block_.block.html">Block</a></p>
<p><em>Overrides <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Block.ts#L24" target="_blank">Block.ts:24</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Block.ts#L24" target="_blank">Block.ts:24</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2178,14 +2178,14 @@
<h2 id="type">Type</h2>
<p>getType(): <code>E</code></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#type">Type</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L142" target="_blank">codec/Struct.ts:142</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L142" target="_blank">codec/Struct.ts:142</a></em></p>
<p><em><strong>description</strong></em>: Returns the Type description to sthe structure</p>
<p><strong>Returns:</strong> <code>E</code></p>
<hr>
<p><a id="contenthash"></a></p>
<h2 id="contenthash">contentHash</h2>
<p>getcontentHash(): <a href="_hash_.hash.html">Hash</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Block.ts#L35" target="_blank">Block.ts:35</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Block.ts#L35" target="_blank">Block.ts:35</a></em></p>
<p><em><strong>description</strong></em>: Encodes a content <a href="_hash_.hash.html">Hash</a> for the block</p>
<p><strong>Returns:</strong> <a href="_hash_.hash.html">Hash</a></p>
<hr>
@@ -2193,28 +2193,28 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L149" target="_blank">codec/Struct.ts:149</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L149" target="_blank">codec/Struct.ts:149</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="extrinsics"></a></p>
<h2 id="extrinsics">extrinsics</h2>
<p>getextrinsics(): <a href="_extrinsics_.extrinsics.html">Extrinsics</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Block.ts#L44" target="_blank">Block.ts:44</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Block.ts#L44" target="_blank">Block.ts:44</a></em></p>
<p><em><strong>description</strong></em>: The <a href="_extrinsics_.extrinsics.html">Extrinsics</a> contained in the block</p>
<p><strong>Returns:</strong> <a href="_extrinsics_.extrinsics.html">Extrinsics</a></p>
<hr>
<p><a id="hash"></a></p>
<h2 id="hash">hash</h2>
<p>gethash(): <a href="_hash_.hash.html">Hash</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Block.ts#L51" target="_blank">Block.ts:51</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Block.ts#L51" target="_blank">Block.ts:51</a></em></p>
<p><em><strong>description</strong></em>: Block/header <a href="_hash_.hash.html">Hash</a></p>
<p><strong>Returns:</strong> <a href="_hash_.hash.html">Hash</a></p>
<hr>
<p><a id="header"></a></p>
<h2 id="header">header</h2>
<p>getheader(): <a href="_header_.header.html">Header</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Block.ts#L58" target="_blank">Block.ts:58</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Block.ts#L58" target="_blank">Block.ts:58</a></em></p>
<p><em><strong>description</strong></em>: The <a href="_header_.header.html">Header</a> of the block</p>
<p><strong>Returns:</strong> <a href="_header_.header.html">Header</a></p>
<hr>
@@ -2224,7 +2224,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L158" target="_blank">codec/Struct.ts:158</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L158" target="_blank">codec/Struct.ts:158</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2248,7 +2248,7 @@
<p>&#x25B8; <strong>get</strong>(name: <em><code>keyof S</code></em>): <a href="../interfaces/_types_.codec.md">Codec</a> | <code>undefined</code></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#get">get</a></em></p>
<p><em>Overrides Map.get</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L166" target="_blank">codec/Struct.ts:166</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L166" target="_blank">codec/Struct.ts:166</a></em></p>
<p><em><strong>description</strong></em>: Returns a specific names entry in the structure</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2273,7 +2273,7 @@
<h2 id="getatindex">getAtIndex</h2>
<p>&#x25B8; <strong>getAtIndex</strong>(index: <em><code>number</code></em>): <a href="../interfaces/_types_.codec.md">Codec</a></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#getatindex">getAtIndex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L173" target="_blank">codec/Struct.ts:173</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L173" target="_blank">codec/Struct.ts:173</a></em></p>
<p><em><strong>description</strong></em>: Returns the values of a member at a specific index (Rather use get(name) for performance)</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2296,7 +2296,7 @@
<h2 id="toarray">toArray</h2>
<p>&#x25B8; <strong>toArray</strong>(): <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#toarray">toArray</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L180" target="_blank">codec/Struct.ts:180</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L180" target="_blank">codec/Struct.ts:180</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to an standard JavaScript Array</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<hr>
@@ -2305,7 +2305,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L187" target="_blank">codec/Struct.ts:187</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L187" target="_blank">codec/Struct.ts:187</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2314,7 +2314,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L194" target="_blank">codec/Struct.ts:194</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L194" target="_blank">codec/Struct.ts:194</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2323,7 +2323,7 @@
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L208" target="_blank">codec/Struct.ts:208</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L208" target="_blank">codec/Struct.ts:208</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2332,7 +2332,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L216" target="_blank">codec/Struct.ts:216</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L216" target="_blank">codec/Struct.ts:216</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2359,7 +2359,7 @@
<h2 id="static-with"><code>&lt;Static&gt;</code> with</h2>
<p>&#x25B8; <strong>with</strong>&lt;<code>S</code>&gt;(Types: <em><code>S</code></em>): <a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_struct_.struct.html">Struct</a>&lt;<code>S</code>&gt;&gt;</p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#with">with</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L122" target="_blank">codec/Struct.ts:122</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L122" target="_blank">codec/Struct.ts:122</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="s---constructordef">S : <a href="../modules/_types_.md#constructordef">ConstructorDef</a></h4>
<p><strong>Parameters:</strong></p>
@@ -2422,7 +2422,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.8","depth":1,"next":{"title":"hidden","level":"4.9","depth":1,"path":"types/classes/_blocknumber_.blocknumber.md","ref":"types/classes/_blocknumber_.blocknumber.md","articles":[]},"previous":{"title":"hidden","level":"4.7","depth":1,"path":"types/classes/_bft_.bfthashsignature.md","ref":"types/classes/_bft_.bfthashsignature.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_block_.block.md","mtime":"2019-01-25T10:38:53.244Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.8","depth":1,"next":{"title":"hidden","level":"4.9","depth":1,"path":"types/classes/_blocknumber_.blocknumber.md","ref":"types/classes/_blocknumber_.blocknumber.md","articles":[]},"previous":{"title":"hidden","level":"4.7","depth":1,"path":"types/classes/_bft_.bfthashsignature.md","ref":"types/classes/_bft_.bfthashsignature.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_block_.block.md","mtime":"2019-01-26T15:31:24.201Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_block_.block.md
+16 -16
View File
@@ -29,7 +29,7 @@
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Block.ts:24](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Block.ts#L24)*
*Defined in [Block.ts:24](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Block.ts#L24)*
**Parameters:**
@@ -51,7 +51,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L142)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L142)*
*__description__*: Returns the Type description to sthe structure
@@ -64,7 +64,7 @@ ___
getcontentHash(): [Hash](_hash_.hash.md)
*Defined in [Block.ts:35](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Block.ts#L35)*
*Defined in [Block.ts:35](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Block.ts#L35)*
*__description__*: Encodes a content [Hash](_hash_.hash.md) for the block
@@ -79,7 +79,7 @@ getencodedLength(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L149)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L149)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -92,7 +92,7 @@ ___
getextrinsics(): [Extrinsics](_extrinsics_.extrinsics.md)
*Defined in [Block.ts:44](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Block.ts#L44)*
*Defined in [Block.ts:44](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Block.ts#L44)*
*__description__*: The [Extrinsics](_extrinsics_.extrinsics.md) contained in the block
@@ -105,7 +105,7 @@ ___
gethash(): [Hash](_hash_.hash.md)
*Defined in [Block.ts:51](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Block.ts#L51)*
*Defined in [Block.ts:51](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Block.ts#L51)*
*__description__*: Block/header [Hash](_hash_.hash.md)
@@ -118,7 +118,7 @@ ___
getheader(): [Header](_header_.header.md)
*Defined in [Block.ts:58](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Block.ts#L58)*
*Defined in [Block.ts:58](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Block.ts#L58)*
*__description__*: The [Header](_header_.header.md) of the block
@@ -138,7 +138,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L158)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L158)*
*__description__*: Compares the value of the input to see if there is a match
@@ -161,7 +161,7 @@ ___
*Overrides Map.get*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L166)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Returns a specific names entry in the structure
@@ -182,7 +182,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L173)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L173)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -203,7 +203,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L180)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -220,7 +220,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L187)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L187)*
*__description__*: Returns a hex string representation of the value
@@ -237,7 +237,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L194)*
*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L194)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -254,7 +254,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L208)*
*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L208)*
*__description__*: Returns the string representation of the value
@@ -271,7 +271,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L216)*
*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L216)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -292,7 +292,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L122)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L122)*
**Type parameters:**
docs/types/classes/_blocknumber_.blocknumber.html
+4 -4
View File
@@ -2150,7 +2150,7 @@
<p>&#x2295; <strong>new BlockNumber</strong>(value?: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>): <a href="_blocknumber_.blocknumber.html">BlockNumber</a></p>
<p><em>Inherited from <a href="_u64_.u64.html">U64</a>.<a href="_u64_.u64.html#constructor">constructor</a></em></p>
<p><em>Overrides <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/U64.ts#L14" target="_blank">U64.ts:14</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/U64.ts#L14" target="_blank">U64.ts:14</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2175,7 +2175,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tohex">toHex</a></em></p>
<p><em>Overrides AbstractInt.toHex</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/UInt.ts#L36" target="_blank">codec/UInt.ts:36</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/UInt.ts#L36" target="_blank">codec/UInt.ts:36</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2185,7 +2185,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tou8a">toU8a</a></em></p>
<p><em>Overrides AbstractInt.toU8a</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/UInt.ts#L48" target="_blank">codec/UInt.ts:48</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/UInt.ts#L48" target="_blank">codec/UInt.ts:48</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2251,7 +2251,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.9","depth":1,"next":{"title":"hidden","level":"4.10","depth":1,"path":"types/classes/_bool_.bool.md","ref":"types/classes/_bool_.bool.md","articles":[]},"previous":{"title":"hidden","level":"4.8","depth":1,"path":"types/classes/_block_.block.md","ref":"types/classes/_block_.block.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_blocknumber_.blocknumber.md","mtime":"2019-01-25T10:38:53.256Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.9","depth":1,"next":{"title":"hidden","level":"4.10","depth":1,"path":"types/classes/_bool_.bool.md","ref":"types/classes/_bool_.bool.md","articles":[]},"previous":{"title":"hidden","level":"4.8","depth":1,"path":"types/classes/_block_.block.md","ref":"types/classes/_block_.block.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_blocknumber_.blocknumber.md","mtime":"2019-01-26T15:31:24.213Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_blocknumber_.blocknumber.md
+3 -3
View File
@@ -26,7 +26,7 @@
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/U64.ts#L14)*
*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/U64.ts#L14)*
**Parameters:**
@@ -52,7 +52,7 @@ ___
*Overrides AbstractInt.toHex*
*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/UInt.ts#L36)*
*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/UInt.ts#L36)*
*__description__*: Returns a hex string representation of the value
@@ -71,7 +71,7 @@ ___
*Overrides AbstractInt.toU8a*
*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/UInt.ts#L48)*
*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/UInt.ts#L48)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_bool_.bool.html
+8 -8
View File
@@ -2148,7 +2148,7 @@
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Bool</strong>(value?: <em><a href="_bool_.bool.html">Bool</a> | <code>Boolean</code> | <code>Uint8Array</code> | <code>boolean</code> | <code>number</code></em>): <a href="_bool_.bool.html">Bool</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bool.ts#L15" target="_blank">Bool.ts:15</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bool.ts#L15" target="_blank">Bool.ts:15</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2182,7 +2182,7 @@
<p><a id="encodedlength"></a></p>
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bool.ts#L35" target="_blank">Bool.ts:35</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bool.ts#L35" target="_blank">Bool.ts:35</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2191,7 +2191,7 @@
<h2 id="eq">eq</h2>
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bool.ts#L42" target="_blank">Bool.ts:42</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bool.ts#L42" target="_blank">Bool.ts:42</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2214,7 +2214,7 @@
<h2 id="tohex">toHex</h2>
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bool.ts#L53" target="_blank">Bool.ts:53</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bool.ts#L53" target="_blank">Bool.ts:53</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2222,7 +2222,7 @@
<h2 id="tojson">toJSON</h2>
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bool.ts#L60" target="_blank">Bool.ts:60</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bool.ts#L60" target="_blank">Bool.ts:60</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2230,7 +2230,7 @@
<h2 id="tostring">toString</h2>
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bool.ts#L67" target="_blank">Bool.ts:67</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bool.ts#L67" target="_blank">Bool.ts:67</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2238,7 +2238,7 @@
<h2 id="tou8a">toU8a</h2>
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bool.ts#L75" target="_blank">Bool.ts:75</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bool.ts#L75" target="_blank">Bool.ts:75</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2304,7 +2304,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.10","depth":1,"next":{"title":"hidden","level":"4.11","depth":1,"path":"types/classes/_bytes_.bytes.md","ref":"types/classes/_bytes_.bytes.md","articles":[]},"previous":{"title":"hidden","level":"4.9","depth":1,"path":"types/classes/_blocknumber_.blocknumber.md","ref":"types/classes/_blocknumber_.blocknumber.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_bool_.bool.md","mtime":"2019-01-25T10:38:53.276Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.10","depth":1,"next":{"title":"hidden","level":"4.11","depth":1,"path":"types/classes/_bytes_.bytes.md","ref":"types/classes/_bytes_.bytes.md","articles":[]},"previous":{"title":"hidden","level":"4.9","depth":1,"path":"types/classes/_blocknumber_.blocknumber.md","ref":"types/classes/_blocknumber_.blocknumber.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_bool_.bool.md","mtime":"2019-01-26T15:31:24.241Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_bool_.bool.md
+7 -7
View File
@@ -22,7 +22,7 @@
⊕ **new Bool**(value?: *[Bool](_bool_.bool.md) | `Boolean` | `Uint8Array` | `boolean` | `number`*): [Bool](_bool_.bool.md)
*Defined in [Bool.ts:15](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bool.ts#L15)*
*Defined in [Bool.ts:15](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bool.ts#L15)*
**Parameters:**
@@ -54,7 +54,7 @@ ___
getencodedLength(): `number`
*Defined in [Bool.ts:35](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bool.ts#L35)*
*Defined in [Bool.ts:35](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bool.ts#L35)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -72,7 +72,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)*
*Defined in [Bool.ts:42](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bool.ts#L42)*
*Defined in [Bool.ts:42](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bool.ts#L42)*
*__description__*: Compares the value of the input to see if there is a match
@@ -93,7 +93,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [Bool.ts:53](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bool.ts#L53)*
*Defined in [Bool.ts:53](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bool.ts#L53)*
*__description__*: Returns a hex string representation of the value
@@ -108,7 +108,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [Bool.ts:60](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bool.ts#L60)*
*Defined in [Bool.ts:60](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bool.ts#L60)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -123,7 +123,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [Bool.ts:67](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bool.ts#L67)*
*Defined in [Bool.ts:67](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bool.ts#L67)*
*__description__*: Returns the string representation of the value
@@ -138,7 +138,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [Bool.ts:75](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bool.ts#L75)*
*Defined in [Bool.ts:75](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bool.ts#L75)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_bytes_.bytes.html
+11 -11
View File
@@ -2156,7 +2156,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Bytes</strong>(value?: <em><a href="../modules/_types_.md#anyu8a">AnyU8a</a></em>): <a href="_bytes_.bytes.html">Bytes</a></p>
<p><em>Overrides <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bytes.ts#L18" target="_blank">Bytes.ts:18</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bytes.ts#L18" target="_blank">Bytes.ts:18</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2179,7 +2179,7 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Overrides <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bytes.ts#L61" target="_blank">Bytes.ts:61</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bytes.ts#L61" target="_blank">Bytes.ts:61</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2187,7 +2187,7 @@
<h2 id="isempty">isEmpty</h2>
<p>getisEmpty(): <code>boolean</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#isempty">isEmpty</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em><strong>description</strong></em>: Returns true if the type wraps an empty/default all-0 value</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
@@ -2196,7 +2196,7 @@
<p>getlength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#length">length</a></em></p>
<p><em>Overrides Uint8Array.length</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50" target="_blank">codec/U8a.ts:50</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50" target="_blank">codec/U8a.ts:50</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2206,7 +2206,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L58" target="_blank">codec/U8a.ts:58</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L58" target="_blank">codec/U8a.ts:58</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2230,7 +2230,7 @@
<p>&#x25B8; <strong>subarray</strong>(begin: <em><code>number</code></em>, end?: <em><code>undefined</code> | <code>number</code></em>): <code>Uint8Array</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#subarray">subarray</a></em></p>
<p><em>Overrides Uint8Array.subarray</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73" target="_blank">codec/U8a.ts:73</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73" target="_blank">codec/U8a.ts:73</a></em></p>
<p><em><strong>description</strong></em>: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2262,7 +2262,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80" target="_blank">codec/U8a.ts:80</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80" target="_blank">codec/U8a.ts:80</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2271,7 +2271,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L87" target="_blank">codec/U8a.ts:87</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L87" target="_blank">codec/U8a.ts:87</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2281,7 +2281,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tostring">toString</a></em></p>
<p><em>Overrides Uint8Array.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L94" target="_blank">codec/U8a.ts:94</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L94" target="_blank">codec/U8a.ts:94</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2290,7 +2290,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Overrides <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bytes.ts#L69" target="_blank">Bytes.ts:69</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bytes.ts#L69" target="_blank">Bytes.ts:69</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2356,7 +2356,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.11","depth":1,"next":{"title":"hidden","level":"4.12","depth":1,"path":"types/classes/_chainproperties_.chainproperties.md","ref":"types/classes/_chainproperties_.chainproperties.md","articles":[]},"previous":{"title":"hidden","level":"4.10","depth":1,"path":"types/classes/_bool_.bool.md","ref":"types/classes/_bool_.bool.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_bytes_.bytes.md","mtime":"2019-01-25T10:38:53.312Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.11","depth":1,"next":{"title":"hidden","level":"4.12","depth":1,"path":"types/classes/_chainproperties_.chainproperties.md","ref":"types/classes/_chainproperties_.chainproperties.md","articles":[]},"previous":{"title":"hidden","level":"4.10","depth":1,"path":"types/classes/_bool_.bool.md","ref":"types/classes/_bool_.bool.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_bytes_.bytes.md","mtime":"2019-01-26T15:31:24.281Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_bytes_.bytes.md
+10 -10
View File
@@ -37,7 +37,7 @@
*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)*
*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bytes.ts#L18)*
*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bytes.ts#L18)*
**Parameters:**
@@ -59,7 +59,7 @@ getencodedLength(): `number`
*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bytes.ts#L61)*
*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bytes.ts#L61)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -74,7 +74,7 @@ getisEmpty(): `boolean`
*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43)*
*__description__*: Returns true if the type wraps an empty/default all-0 value
@@ -91,7 +91,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50)*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50)*
*__description__*: The length of the value
@@ -111,7 +111,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L58)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L58)*
*__description__*: Compares the value of the input to see if there is a match
@@ -134,7 +134,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73)*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -158,7 +158,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80)*
*__description__*: Returns a hex string representation of the value
@@ -175,7 +175,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L87)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L87)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -194,7 +194,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L94)*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L94)*
*__description__*: Returns the string representation of the value
@@ -211,7 +211,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [Bytes.ts:69](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bytes.ts#L69)*
*Defined in [Bytes.ts:69](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bytes.ts#L69)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_chainproperties_.chainproperties.html
+10 -10
View File
@@ -2148,7 +2148,7 @@
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new ChainProperties</strong>(value?: <em><code>object</code> | <code>null</code></em>): <a href="_chainproperties_.chainproperties.html">ChainProperties</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ChainProperties.ts#L17" target="_blank">ChainProperties.ts:17</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ChainProperties.ts#L17" target="_blank">ChainProperties.ts:17</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2177,21 +2177,21 @@
<p><a id="encodedlength"></a></p>
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ChainProperties.ts#L29" target="_blank">ChainProperties.ts:29</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ChainProperties.ts#L29" target="_blank">ChainProperties.ts:29</a></em></p>
<p><em><strong>description</strong></em>: Always 0, never encodes as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="tokendecimals"></a></p>
<h2 id="tokendecimals">tokenDecimals</h2>
<p>gettokenDecimals(): <code>number</code> | <code>undefined</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ChainProperties.ts#L36" target="_blank">ChainProperties.ts:36</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ChainProperties.ts#L36" target="_blank">ChainProperties.ts:36</a></em></p>
<p><em><strong>description</strong></em>: The token decimals, if defined (de-facto standard only)</p>
<p><strong>Returns:</strong> <code>number</code> | <code>undefined</code></p>
<hr>
<p><a id="tokensymbol"></a></p>
<h2 id="tokensymbol">tokenSymbol</h2>
<p>gettokenSymbol(): <code>number</code> | <code>undefined</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ChainProperties.ts#L43" target="_blank">ChainProperties.ts:43</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ChainProperties.ts#L43" target="_blank">ChainProperties.ts:43</a></em></p>
<p><em><strong>description</strong></em>: The token system, if defined (de-facto standard only)</p>
<p><strong>Returns:</strong> <code>number</code> | <code>undefined</code></p>
<hr>
@@ -2200,7 +2200,7 @@
<h2 id="eq">eq</h2>
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ChainProperties.ts#L50" target="_blank">ChainProperties.ts:50</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ChainProperties.ts#L50" target="_blank">ChainProperties.ts:50</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2223,7 +2223,7 @@
<h2 id="tohex">toHex</h2>
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ChainProperties.ts#L57" target="_blank">ChainProperties.ts:57</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ChainProperties.ts#L57" target="_blank">ChainProperties.ts:57</a></em></p>
<p><em><strong>description</strong></em>: Unimplemented, will throw</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2231,7 +2231,7 @@
<h2 id="tojson">toJSON</h2>
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ChainProperties.ts#L64" target="_blank">ChainProperties.ts:64</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ChainProperties.ts#L64" target="_blank">ChainProperties.ts:64</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2239,7 +2239,7 @@
<h2 id="tostring">toString</h2>
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ChainProperties.ts#L75" target="_blank">ChainProperties.ts:75</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ChainProperties.ts#L75" target="_blank">ChainProperties.ts:75</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2247,7 +2247,7 @@
<h2 id="tou8a">toU8a</h2>
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ChainProperties.ts#L82" target="_blank">ChainProperties.ts:82</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ChainProperties.ts#L82" target="_blank">ChainProperties.ts:82</a></em></p>
<p><em><strong>description</strong></em>: Unimplemented, will throw</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2311,7 +2311,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.12","depth":1,"next":{"title":"hidden","level":"4.13","depth":1,"path":"types/classes/_codec_base_.base.md","ref":"types/classes/_codec_base_.base.md","articles":[]},"previous":{"title":"hidden","level":"4.11","depth":1,"path":"types/classes/_bytes_.bytes.md","ref":"types/classes/_bytes_.bytes.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_chainproperties_.chainproperties.md","mtime":"2019-01-25T10:38:53.336Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.12","depth":1,"next":{"title":"hidden","level":"4.13","depth":1,"path":"types/classes/_codec_base_.base.md","ref":"types/classes/_codec_base_.base.md","articles":[]},"previous":{"title":"hidden","level":"4.11","depth":1,"path":"types/classes/_bytes_.bytes.md","ref":"types/classes/_bytes_.bytes.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_chainproperties_.chainproperties.md","mtime":"2019-01-26T15:31:24.305Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_chainproperties_.chainproperties.md
+9 -9
View File
@@ -22,7 +22,7 @@
⊕ **new ChainProperties**(value?: *`object` | `null`*): [ChainProperties](_chainproperties_.chainproperties.md)
*Defined in [ChainProperties.ts:17](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ChainProperties.ts#L17)*
*Defined in [ChainProperties.ts:17](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ChainProperties.ts#L17)*
**Parameters:**
@@ -54,7 +54,7 @@ ___
getencodedLength(): `number`
*Defined in [ChainProperties.ts:29](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ChainProperties.ts#L29)*
*Defined in [ChainProperties.ts:29](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ChainProperties.ts#L29)*
*__description__*: Always 0, never encodes as a Uint8Array
@@ -67,7 +67,7 @@ ___
gettokenDecimals(): `number` | `undefined`
*Defined in [ChainProperties.ts:36](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ChainProperties.ts#L36)*
*Defined in [ChainProperties.ts:36](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ChainProperties.ts#L36)*
*__description__*: The token decimals, if defined (de-facto standard only)
@@ -80,7 +80,7 @@ ___
gettokenSymbol(): `number` | `undefined`
*Defined in [ChainProperties.ts:43](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ChainProperties.ts#L43)*
*Defined in [ChainProperties.ts:43](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ChainProperties.ts#L43)*
*__description__*: The token system, if defined (de-facto standard only)
@@ -98,7 +98,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)*
*Defined in [ChainProperties.ts:50](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ChainProperties.ts#L50)*
*Defined in [ChainProperties.ts:50](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ChainProperties.ts#L50)*
*__description__*: Compares the value of the input to see if there is a match
@@ -119,7 +119,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [ChainProperties.ts:57](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ChainProperties.ts#L57)*
*Defined in [ChainProperties.ts:57](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ChainProperties.ts#L57)*
*__description__*: Unimplemented, will throw
@@ -134,7 +134,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [ChainProperties.ts:64](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ChainProperties.ts#L64)*
*Defined in [ChainProperties.ts:64](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ChainProperties.ts#L64)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -149,7 +149,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [ChainProperties.ts:75](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ChainProperties.ts#L75)*
*Defined in [ChainProperties.ts:75](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ChainProperties.ts#L75)*
*__description__*: Returns the string representation of the value
@@ -164,7 +164,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [ChainProperties.ts:82](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ChainProperties.ts#L82)*
*Defined in [ChainProperties.ts:82](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ChainProperties.ts#L82)*
*__description__*: Unimplemented, will throw
docs/types/classes/_codec_base_.base.html
+2 -2
View File
@@ -2151,7 +2151,7 @@
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Base</strong>(value?: <em><code>any</code></em>): <a href="_codec_base_.base.html">Base</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Base.ts#L10" target="_blank">codec/Base.ts:10</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Base.ts#L10" target="_blank">codec/Base.ts:10</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2212,7 +2212,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.13","depth":1,"next":{"title":"hidden","level":"4.14","depth":1,"path":"types/classes/_codec_compact_.compact.md","ref":"types/classes/_codec_compact_.compact.md","articles":[]},"previous":{"title":"hidden","level":"4.12","depth":1,"path":"types/classes/_chainproperties_.chainproperties.md","ref":"types/classes/_chainproperties_.chainproperties.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_base_.base.md","mtime":"2019-01-25T10:38:56.932Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.13","depth":1,"next":{"title":"hidden","level":"4.14","depth":1,"path":"types/classes/_codec_compact_.compact.md","ref":"types/classes/_codec_compact_.compact.md","articles":[]},"previous":{"title":"hidden","level":"4.12","depth":1,"path":"types/classes/_chainproperties_.chainproperties.md","ref":"types/classes/_chainproperties_.chainproperties.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_base_.base.md","mtime":"2019-01-26T15:31:28.193Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_codec_base_.base.md
+1 -1
View File
@@ -30,7 +30,7 @@
⊕ **new Base**(value?: *`any`*): [Base](_codec_base_.base.md)
*Defined in [codec/Base.ts:10](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Base.ts#L10)*
*Defined in [codec/Base.ts:10](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Base.ts#L10)*
**Parameters:**
docs/types/classes/_codec_compact_.compact.html
+17 -17
View File
@@ -2150,7 +2150,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Compact</strong>(Type: <em><a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_uint_.uint.html">UInt</a> | <a href="_moment_.moment.html">Moment</a>&gt;</em>, value?: <em><a href="_codec_compact_.compact.html">Compact</a> | <a href="../modules/_types_.md#anynumber">AnyNumber</a></em>): <a href="_codec_compact_.compact.html">Compact</a></p>
<p><em>Overrides <a href="_codec_base_.base.html">Base</a>.<a href="_codec_base_.base.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L23" target="_blank">codec/Compact.ts:23</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L23" target="_blank">codec/Compact.ts:23</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2181,25 +2181,25 @@
<p><a id="addlengthprefix"></a></p>
<h2 id="static-addlengthprefix"><code>&lt;Static&gt;</code> addLengthPrefix</h2>
<p><strong>&#x25CF; addLengthPrefix</strong>: <em><code>compactAddLength</code></em> = compactAddLength</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L41" target="_blank">codec/Compact.ts:41</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L41" target="_blank">codec/Compact.ts:41</a></em></p>
<p>Prepend a Uint8Array with its compact length.
<em><strong>param</strong></em>: The Uint8Array to be prefixed</p>
<hr>
<p><a id="decodeu8a"></a></p>
<h2 id="static-decodeu8a"><code>&lt;Static&gt;</code> decodeU8a</h2>
<p><strong>&#x25CF; decodeU8a</strong>: <em><code>compactFromU8a</code></em> = compactFromU8a</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L42" target="_blank">codec/Compact.ts:42</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L42" target="_blank">codec/Compact.ts:42</a></em></p>
<hr>
<p><a id="encodeu8a"></a></p>
<h2 id="static-encodeu8a"><code>&lt;Static&gt;</code> encodeU8a</h2>
<p><strong>&#x25CF; encodeU8a</strong>: <em><code>compactToU8a</code></em> = compactToU8a</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L43" target="_blank">codec/Compact.ts:43</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L43" target="_blank">codec/Compact.ts:43</a></em></p>
<hr>
<h1 id="accessors">Accessors</h1>
<p><a id="encodedlength"></a></p>
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L72" target="_blank">codec/Compact.ts:72</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L72" target="_blank">codec/Compact.ts:72</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2207,7 +2207,7 @@
<p><a id="bitlength"></a></p>
<h2 id="bitlength">bitLength</h2>
<p>&#x25B8; <strong>bitLength</strong>(): <a href="../modules/_codec_abstractint_.md#uintbitlength">UIntBitLength</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L79" target="_blank">codec/Compact.ts:79</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L79" target="_blank">codec/Compact.ts:79</a></em></p>
<p><em><strong>description</strong></em>: Returns the number of bits in the value</p>
<p><strong>Returns:</strong> <a href="../modules/_codec_abstractint_.md#uintbitlength">UIntBitLength</a></p>
<hr>
@@ -2215,7 +2215,7 @@
<h2 id="eq">eq</h2>
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L86" target="_blank">codec/Compact.ts:86</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L86" target="_blank">codec/Compact.ts:86</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2237,7 +2237,7 @@
<p><a id="tobn"></a></p>
<h2 id="tobn">toBn</h2>
<p>&#x25B8; <strong>toBn</strong>(): <code>BN</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L97" target="_blank">codec/Compact.ts:97</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L97" target="_blank">codec/Compact.ts:97</a></em></p>
<p><em><strong>description</strong></em>: Returns the BN representation of the number</p>
<p><strong>Returns:</strong> <code>BN</code></p>
<hr>
@@ -2245,7 +2245,7 @@
<h2 id="tohex">toHex</h2>
<p>&#x25B8; <strong>toHex</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L104" target="_blank">codec/Compact.ts:104</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L104" target="_blank">codec/Compact.ts:104</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2253,14 +2253,14 @@
<h2 id="tojson">toJSON</h2>
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L111" target="_blank">codec/Compact.ts:111</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L111" target="_blank">codec/Compact.ts:111</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
<p><a id="tonumber"></a></p>
<h2 id="tonumber">toNumber</h2>
<p>&#x25B8; <strong>toNumber</strong>(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L118" target="_blank">codec/Compact.ts:118</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L118" target="_blank">codec/Compact.ts:118</a></em></p>
<p><em><strong>description</strong></em>: Returns the number representation for the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2268,7 +2268,7 @@
<h2 id="tostring">toString</h2>
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L125" target="_blank">codec/Compact.ts:125</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L125" target="_blank">codec/Compact.ts:125</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2276,7 +2276,7 @@
<h2 id="tou8a">toU8a</h2>
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L133" target="_blank">codec/Compact.ts:133</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L133" target="_blank">codec/Compact.ts:133</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2302,7 +2302,7 @@
<p><a id="decodecompact"></a></p>
<h2 id="static-decodecompact"><code>&lt;Static&gt;</code> decodeCompact</h2>
<p>&#x25B8; <strong>decodeCompact</strong>(Type: <em><a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_uint_.uint.html">UInt</a> | <a href="_moment_.moment.html">Moment</a>&gt;</em>, value: <em><a href="_codec_compact_.compact.html">Compact</a> | <a href="../modules/_types_.md#anynumber">AnyNumber</a></em>): <a href="_moment_.moment.html">Moment</a> | <a href="_codec_uint_.uint.html">UInt</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L51" target="_blank">codec/Compact.ts:51</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L51" target="_blank">codec/Compact.ts:51</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2329,7 +2329,7 @@
<p><a id="striplengthprefix"></a></p>
<h2 id="static-striplengthprefix"><code>&lt;Static&gt;</code> stripLengthPrefix</h2>
<p>&#x25B8; <strong>stripLengthPrefix</strong>(u8a: <em><code>Uint8Array</code></em>, bitLength?: <em><a href="../modules/_codec_abstractint_.md#uintbitlength">UIntBitLength</a></em>): <code>Uint8Array</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L45" target="_blank">codec/Compact.ts:45</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L45" target="_blank">codec/Compact.ts:45</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2357,7 +2357,7 @@
<p><a id="with"></a></p>
<h2 id="static-with"><code>&lt;Static&gt;</code> with</h2>
<p>&#x25B8; <strong>with</strong>(Type: <em><a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_uint_.uint.html">UInt</a> | <a href="_moment_.moment.html">Moment</a>&gt;</em>): <a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_compact_.compact.html">Compact</a>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L28" target="_blank">codec/Compact.ts:28</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L28" target="_blank">codec/Compact.ts:28</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2419,7 +2419,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.14","depth":1,"next":{"title":"hidden","level":"4.15","depth":1,"path":"types/classes/_codec_enum_.enum.md","ref":"types/classes/_codec_enum_.enum.md","articles":[]},"previous":{"title":"hidden","level":"4.13","depth":1,"path":"types/classes/_codec_base_.base.md","ref":"types/classes/_codec_base_.base.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_compact_.compact.md","mtime":"2019-01-25T10:38:56.952Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.14","depth":1,"next":{"title":"hidden","level":"4.15","depth":1,"path":"types/classes/_codec_enum_.enum.md","ref":"types/classes/_codec_enum_.enum.md","articles":[]},"previous":{"title":"hidden","level":"4.13","depth":1,"path":"types/classes/_codec_base_.base.md","ref":"types/classes/_codec_base_.base.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_compact_.compact.md","mtime":"2019-01-26T15:31:28.217Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_codec_compact_.compact.md
+16 -16
View File
@@ -26,7 +26,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Compact.ts:23](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L23)*
*Defined in [codec/Compact.ts:23](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L23)*
**Parameters:**
@@ -47,7 +47,7 @@ ___
**● addLengthPrefix**: *`compactAddLength`* = compactAddLength
*Defined in [codec/Compact.ts:41](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L41)*
*Defined in [codec/Compact.ts:41](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L41)*
Prepend a Uint8Array with its compact length.
*__param__*: The Uint8Array to be prefixed
@@ -59,7 +59,7 @@ ___
**● decodeU8a**: *`compactFromU8a`* = compactFromU8a
*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L42)*
*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L42)*
___
<a id="encodeu8a"></a>
@@ -68,7 +68,7 @@ ___
**● encodeU8a**: *`compactToU8a`* = compactToU8a
*Defined in [codec/Compact.ts:43](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L43)*
*Defined in [codec/Compact.ts:43](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L43)*
___
@@ -80,7 +80,7 @@ ___
getencodedLength(): `number`
*Defined in [codec/Compact.ts:72](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L72)*
*Defined in [codec/Compact.ts:72](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L72)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -96,7 +96,7 @@ ___
▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)
*Defined in [codec/Compact.ts:79](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L79)*
*Defined in [codec/Compact.ts:79](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L79)*
*__description__*: Returns the number of bits in the value
@@ -111,7 +111,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L86)*
*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L86)*
*__description__*: Compares the value of the input to see if there is a match
@@ -130,7 +130,7 @@ ___
▸ **toBn**(): `BN`
*Defined in [codec/Compact.ts:97](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L97)*
*Defined in [codec/Compact.ts:97](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L97)*
*__description__*: Returns the BN representation of the number
@@ -145,7 +145,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/Compact.ts:104](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L104)*
*Defined in [codec/Compact.ts:104](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L104)*
*__description__*: Returns a hex string representation of the value
@@ -160,7 +160,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/Compact.ts:111](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L111)*
*Defined in [codec/Compact.ts:111](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L111)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -173,7 +173,7 @@ ___
▸ **toNumber**(): `number`
*Defined in [codec/Compact.ts:118](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L118)*
*Defined in [codec/Compact.ts:118](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L118)*
*__description__*: Returns the number representation for the value
@@ -188,7 +188,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [codec/Compact.ts:125](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L125)*
*Defined in [codec/Compact.ts:125](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L125)*
*__description__*: Returns the string representation of the value
@@ -203,7 +203,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [codec/Compact.ts:133](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L133)*
*Defined in [codec/Compact.ts:133](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L133)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -222,7 +222,7 @@ ___
▸ **decodeCompact**(Type: *[Constructor](../modules/_types_.md#constructor)<[UInt](_codec_uint_.uint.md) | [Moment](_moment_.moment.md)>*, value: *[Compact](_codec_compact_.compact.md) | [AnyNumber](../modules/_types_.md#anynumber)*): [Moment](_moment_.moment.md) | [UInt](_codec_uint_.uint.md)
*Defined in [codec/Compact.ts:51](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L51)*
*Defined in [codec/Compact.ts:51](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L51)*
**Parameters:**
@@ -240,7 +240,7 @@ ___
▸ **stripLengthPrefix**(u8a: *`Uint8Array`*, bitLength?: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*): `Uint8Array`
*Defined in [codec/Compact.ts:45](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L45)*
*Defined in [codec/Compact.ts:45](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L45)*
**Parameters:**
@@ -258,7 +258,7 @@ ___
▸ **with**(Type: *[Constructor](../modules/_types_.md#constructor)<[UInt](_codec_uint_.uint.md) | [Moment](_moment_.moment.md)>*): [Constructor](../modules/_types_.md#constructor)<[Compact](_codec_compact_.compact.md)>
*Defined in [codec/Compact.ts:28](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Compact.ts#L28)*
*Defined in [codec/Compact.ts:28](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Compact.ts#L28)*
**Parameters:**
docs/types/classes/_codec_enum_.enum.html
+11 -11
View File
@@ -2140,7 +2140,7 @@
<h1 id="hierarchy">Hierarchy</h1>
<p> <a href="_codec_base_.base.html">Base</a>&lt;<code>number</code>&gt;</p>
<p><strong>&#x21B3; Enum</strong></p>
<p>&#x21B3; <a href="_metadata_modules_.storagefunctionmodifier.md">StorageFunctionModifier</a></p>
<p>&#x21B3; <a href="_metadata_v0_modules_.storagefunctionmodifier.md">StorageFunctionModifier</a></p>
<p>&#x21B3; <a href="_newaccountoutcome_.newaccountoutcome.html">NewAccountOutcome</a></p>
<p>&#x21B3; <a href="_votethreshold_.votethreshold.html">VoteThreshold</a></p>
<h1 id="implements">Implements</h1>
@@ -2152,7 +2152,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Enum</strong>(def: <em><code>EnumDef</code></em>, value?: <em><a href="_codec_enum_.enum.html">Enum</a> | <code>Uint8Array</code> | <code>string</code> | <code>number</code></em>): <a href="_codec_enum_.enum.html">Enum</a></p>
<p><em>Overrides <a href="_codec_base_.base.html">Base</a>.<a href="_codec_base_.base.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Enum.ts#L29" target="_blank">codec/Enum.ts:29</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Enum.ts#L29" target="_blank">codec/Enum.ts:29</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2184,7 +2184,7 @@
<p><a id="encodedlength"></a></p>
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Enum.ts#L64" target="_blank">codec/Enum.ts:64</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Enum.ts#L64" target="_blank">codec/Enum.ts:64</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2193,7 +2193,7 @@
<h2 id="eq">eq</h2>
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Enum.ts#L71" target="_blank">codec/Enum.ts:71</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Enum.ts#L71" target="_blank">codec/Enum.ts:71</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2216,7 +2216,7 @@
<h2 id="tohex">toHex</h2>
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Enum.ts#L84" target="_blank">codec/Enum.ts:84</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Enum.ts#L84" target="_blank">codec/Enum.ts:84</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2224,14 +2224,14 @@
<h2 id="tojson">toJSON</h2>
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Enum.ts#L91" target="_blank">codec/Enum.ts:91</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Enum.ts#L91" target="_blank">codec/Enum.ts:91</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
<p><a id="tonumber"></a></p>
<h2 id="tonumber">toNumber</h2>
<p>&#x25B8; <strong>toNumber</strong>(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Enum.ts#L98" target="_blank">codec/Enum.ts:98</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Enum.ts#L98" target="_blank">codec/Enum.ts:98</a></em></p>
<p><em><strong>description</strong></em>: Returns the number representation for the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2239,7 +2239,7 @@
<h2 id="tostring">toString</h2>
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Enum.ts#L105" target="_blank">codec/Enum.ts:105</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Enum.ts#L105" target="_blank">codec/Enum.ts:105</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2247,7 +2247,7 @@
<h2 id="tou8a">toU8a</h2>
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Enum.ts#L113" target="_blank">codec/Enum.ts:113</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Enum.ts#L113" target="_blank">codec/Enum.ts:113</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2273,7 +2273,7 @@
<p><a id="decodeenum"></a></p>
<h2 id="static-decodeenum"><code>&lt;Static&gt;</code> decodeEnum</h2>
<p>&#x25B8; <strong>decodeEnum</strong>(def: <em><code>EnumDef</code></em>, value: <em><a href="_codec_enum_.enum.html">Enum</a> | <code>Uint8Array</code> | <code>string</code> | <code>number</code></em>): <code>number</code> | <code>undefined</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Enum.ts#L47" target="_blank">codec/Enum.ts:47</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Enum.ts#L47" target="_blank">codec/Enum.ts:47</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2341,7 +2341,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.15","depth":1,"next":{"title":"hidden","level":"4.16","depth":1,"path":"types/classes/_codec_enumtype_.enumtype.md","ref":"types/classes/_codec_enumtype_.enumtype.md","articles":[]},"previous":{"title":"hidden","level":"4.14","depth":1,"path":"types/classes/_codec_compact_.compact.md","ref":"types/classes/_codec_compact_.compact.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_enum_.enum.md","mtime":"2019-01-25T10:38:56.972Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.15","depth":1,"next":{"title":"hidden","level":"4.16","depth":1,"path":"types/classes/_codec_enumtype_.enumtype.md","ref":"types/classes/_codec_enumtype_.enumtype.md","articles":[]},"previous":{"title":"hidden","level":"4.14","depth":1,"path":"types/classes/_codec_compact_.compact.md","ref":"types/classes/_codec_compact_.compact.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_enum_.enum.md","mtime":"2019-01-26T15:31:28.241Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_codec_enum_.enum.md
+10 -10
View File
@@ -10,7 +10,7 @@
**↳ Enum**
↳ [StorageFunctionModifier](_metadata_modules_.storagefunctionmodifier.md)
↳ [StorageFunctionModifier](_metadata_v0_modules_.storagefunctionmodifier.md)
↳ [NewAccountOutcome](_newaccountoutcome_.newaccountoutcome.md)
@@ -30,7 +30,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Enum.ts:29](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Enum.ts#L29)*
*Defined in [codec/Enum.ts:29](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Enum.ts#L29)*
**Parameters:**
@@ -51,7 +51,7 @@ ___
getencodedLength(): `number`
*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Enum.ts#L64)*
*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Enum.ts#L64)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -69,7 +69,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)*
*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Enum.ts#L71)*
*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Enum.ts#L71)*
*__description__*: Compares the value of the input to see if there is a match
@@ -90,7 +90,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/Enum.ts:84](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Enum.ts#L84)*
*Defined in [codec/Enum.ts:84](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Enum.ts#L84)*
*__description__*: Returns a hex string representation of the value
@@ -105,7 +105,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/Enum.ts:91](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Enum.ts#L91)*
*Defined in [codec/Enum.ts:91](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Enum.ts#L91)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -118,7 +118,7 @@ ___
▸ **toNumber**(): `number`
*Defined in [codec/Enum.ts:98](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Enum.ts#L98)*
*Defined in [codec/Enum.ts:98](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Enum.ts#L98)*
*__description__*: Returns the number representation for the value
@@ -133,7 +133,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [codec/Enum.ts:105](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Enum.ts#L105)*
*Defined in [codec/Enum.ts:105](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Enum.ts#L105)*
*__description__*: Returns the string representation of the value
@@ -148,7 +148,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [codec/Enum.ts:113](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Enum.ts#L113)*
*Defined in [codec/Enum.ts:113](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Enum.ts#L113)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -167,7 +167,7 @@ ___
▸ **decodeEnum**(def: *`EnumDef`*, value: *[Enum](_codec_enum_.enum.md) | `Uint8Array` | `string` | `number`*): `number` | `undefined`
*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Enum.ts#L47)*
*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Enum.ts#L47)*
**Parameters:**
docs/types/classes/_codec_enumtype_.enumtype.html
+21 -14
View File
@@ -2143,7 +2143,7 @@
<p> <a href="_codec_base_.base.html">Base</a>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><strong>&#x21B3; EnumType</strong></p>
<p>&#x21B3; <a href="_attestedcandidate_.validityattestation.md">ValidityAttestation</a></p>
<p>&#x21B3; <a href="_metadata_modules_.storagefunctiontype.md">StorageFunctionType</a></p>
<p>&#x21B3; <a href="_metadata_v0_modules_.storagefunctiontype.md">StorageFunctionType</a></p>
<p>&#x21B3; <a href="_digest_.digestitem.html">DigestItem</a></p>
<p>&#x21B3; <a href="_eventrecord_.phase.html">Phase</a></p>
<p>&#x21B3; <a href="_extrinsicstatus_.extrinsicstatus.html">ExtrinsicStatus</a></p>
@@ -2157,7 +2157,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new EnumType</strong>(def: <em><code>TypesDef</code></em>, value?: <em><code>any</code></em>, index?: <em><code>number</code> | <a href="_codec_enumtype_.enumtype.html">EnumType</a>&lt;<code>T</code>&gt;</em>): <a href="_codec_enumtype_.enumtype.html">EnumType</a></p>
<p><em>Overrides <a href="_codec_base_.base.html">Base</a>.<a href="_codec_base_.base.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L32" target="_blank">codec/EnumType.ts:32</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L32" target="_blank">codec/EnumType.ts:32</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2188,35 +2188,42 @@
<p><a id="encodedlength"></a></p>
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L101" target="_blank">codec/EnumType.ts:101</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L101" target="_blank">codec/EnumType.ts:101</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="index"></a></p>
<h2 id="index">index</h2>
<p>getindex(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L108" target="_blank">codec/EnumType.ts:108</a></em></p>
<p><em><strong>description</strong></em>: The index of the metadata value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="isnone"></a></p>
<h2 id="isnone">isNone</h2>
<p>getisNone(): <code>boolean</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L108" target="_blank">codec/EnumType.ts:108</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L115" target="_blank">codec/EnumType.ts:115</a></em></p>
<p><em><strong>description</strong></em>: Checks if the Enum points to a <a href="_null_.null.html">Null</a> type</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
<p><a id="isnull"></a></p>
<h2 id="isnull">isNull</h2>
<p>getisNull(): <code>boolean</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L115" target="_blank">codec/EnumType.ts:115</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L122" target="_blank">codec/EnumType.ts:122</a></em></p>
<p><em><strong>description</strong></em>: Checks if the Enum points to a <a href="_null_.null.html">Null</a> type (deprecated, use isNone)</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
<p><a id="type"></a></p>
<h2 id="type">type</h2>
<p>gettype(): <code>string</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L122" target="_blank">codec/EnumType.ts:122</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L129" target="_blank">codec/EnumType.ts:129</a></em></p>
<p><em><strong>description</strong></em>: The name of the type this enum value represents</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
<p><a id="value"></a></p>
<h2 id="value">value</h2>
<p>getvalue(): <a href="../interfaces/_types_.codec.md">Codec</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L129" target="_blank">codec/EnumType.ts:129</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L136" target="_blank">codec/EnumType.ts:136</a></em></p>
<p><em><strong>description</strong></em>: The value of the enum</p>
<p><strong>Returns:</strong> <a href="../interfaces/_types_.codec.md">Codec</a></p>
<hr>
@@ -2225,7 +2232,7 @@
<h2 id="eq">eq</h2>
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L136" target="_blank">codec/EnumType.ts:136</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L143" target="_blank">codec/EnumType.ts:143</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2248,7 +2255,7 @@
<h2 id="tohex">toHex</h2>
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L149" target="_blank">codec/EnumType.ts:149</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L156" target="_blank">codec/EnumType.ts:156</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2256,14 +2263,14 @@
<h2 id="tojson">toJSON</h2>
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L156" target="_blank">codec/EnumType.ts:156</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L163" target="_blank">codec/EnumType.ts:163</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
<p><a id="tonumber"></a></p>
<h2 id="tonumber">toNumber</h2>
<p>&#x25B8; <strong>toNumber</strong>(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L163" target="_blank">codec/EnumType.ts:163</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L170" target="_blank">codec/EnumType.ts:170</a></em></p>
<p><em><strong>description</strong></em>: Returns the number representation for the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2271,7 +2278,7 @@
<h2 id="tostring">toString</h2>
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L170" target="_blank">codec/EnumType.ts:170</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L177" target="_blank">codec/EnumType.ts:177</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2279,7 +2286,7 @@
<h2 id="tou8a">toU8a</h2>
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L178" target="_blank">codec/EnumType.ts:178</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L185" target="_blank">codec/EnumType.ts:185</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2345,7 +2352,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.16","depth":1,"next":{"title":"hidden","level":"4.17","depth":1,"path":"types/classes/_codec_option_.option.md","ref":"types/classes/_codec_option_.option.md","articles":[]},"previous":{"title":"hidden","level":"4.15","depth":1,"path":"types/classes/_codec_enum_.enum.md","ref":"types/classes/_codec_enum_.enum.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_enumtype_.enumtype.md","mtime":"2019-01-25T10:38:57.004Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.16","depth":1,"next":{"title":"hidden","level":"4.17","depth":1,"path":"types/classes/_codec_option_.option.md","ref":"types/classes/_codec_option_.option.md","articles":[]},"previous":{"title":"hidden","level":"4.15","depth":1,"path":"types/classes/_codec_enum_.enum.md","ref":"types/classes/_codec_enum_.enum.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_enumtype_.enumtype.md","mtime":"2019-01-26T15:31:28.277Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_codec_enumtype_.enumtype.md
+26 -13
View File
@@ -14,7 +14,7 @@
↳ [ValidityAttestation](_attestedcandidate_.validityattestation.md)
↳ [StorageFunctionType](_metadata_modules_.storagefunctiontype.md)
↳ [StorageFunctionType](_metadata_v0_modules_.storagefunctiontype.md)
↳ [DigestItem](_digest_.digestitem.md)
@@ -38,7 +38,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/EnumType.ts:32](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L32)*
*Defined in [codec/EnumType.ts:32](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L32)*
**Parameters:**
@@ -60,12 +60,25 @@ ___
getencodedLength(): `number`
*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L101)*
*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L101)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
___
<a id="index"></a>
## index
getindex(): `number`
*Defined in [codec/EnumType.ts:108](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L108)*
*__description__*: The index of the metadata value
**Returns:** `number`
___
<a id="isnone"></a>
@@ -73,7 +86,7 @@ ___
getisNone(): `boolean`
*Defined in [codec/EnumType.ts:108](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L108)*
*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L115)*
*__description__*: Checks if the Enum points to a [Null](_null_.null.md) type
@@ -86,7 +99,7 @@ ___
getisNull(): `boolean`
*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L115)*
*Defined in [codec/EnumType.ts:122](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L122)*
*__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone)
@@ -99,7 +112,7 @@ ___
gettype(): `string`
*Defined in [codec/EnumType.ts:122](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L122)*
*Defined in [codec/EnumType.ts:129](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L129)*
*__description__*: The name of the type this enum value represents
@@ -112,7 +125,7 @@ ___
getvalue(): [Codec](../interfaces/_types_.codec.md)
*Defined in [codec/EnumType.ts:129](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L129)*
*Defined in [codec/EnumType.ts:136](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L136)*
*__description__*: The value of the enum
@@ -130,7 +143,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)*
*Defined in [codec/EnumType.ts:136](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L136)*
*Defined in [codec/EnumType.ts:143](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L143)*
*__description__*: Compares the value of the input to see if there is a match
@@ -151,7 +164,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L149)*
*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L156)*
*__description__*: Returns a hex string representation of the value
@@ -166,7 +179,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L156)*
*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L163)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -179,7 +192,7 @@ ___
▸ **toNumber**(): `number`
*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L163)*
*Defined in [codec/EnumType.ts:170](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L170)*
*__description__*: Returns the number representation for the value
@@ -194,7 +207,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [codec/EnumType.ts:170](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L170)*
*Defined in [codec/EnumType.ts:177](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L177)*
*__description__*: Returns the string representation of the value
@@ -209,7 +222,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [codec/EnumType.ts:178](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L178)*
*Defined in [codec/EnumType.ts:185](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L185)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_codec_int_.int.md
+3 -3
View File
@@ -36,7 +36,7 @@
*Overrides AbstractInt.__constructor*
*Defined in [codec/Int.ts:21](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Int.ts#L21)*
*Defined in [codec/Int.ts:21](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Int.ts#L21)*
**Parameters:**
@@ -62,7 +62,7 @@ ___
*Overrides AbstractInt.toHex*
*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Int.ts#L36)*
*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Int.ts#L36)*
*__description__*: Returns a hex string representation of the value
@@ -79,7 +79,7 @@ ___
*Overrides AbstractInt.toU8a*
*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Int.ts#L48)*
*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Int.ts#L48)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_codec_option_.option.html
+14 -14
View File
@@ -2151,7 +2151,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Option</strong>(Type: <em><a href="../modules/_types_.md#constructor">Constructor</a></em>, value?: <em><code>any</code></em>): <a href="_codec_option_.option.html">Option</a></p>
<p><em>Overrides <a href="_codec_base_.base.html">Base</a>.<a href="_codec_base_.base.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L19" target="_blank">codec/Option.ts:19</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L19" target="_blank">codec/Option.ts:19</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2177,28 +2177,28 @@
<p><a id="encodedlength"></a></p>
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L52" target="_blank">codec/Option.ts:52</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L52" target="_blank">codec/Option.ts:52</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="isnone"></a></p>
<h2 id="isnone">isNone</h2>
<p>getisNone(): <code>boolean</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L60" target="_blank">codec/Option.ts:60</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L60" target="_blank">codec/Option.ts:60</a></em></p>
<p><em><strong>description</strong></em>: Checks if the Option has no value</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
<p><a id="issome"></a></p>
<h2 id="issome">isSome</h2>
<p>getisSome(): <code>boolean</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L67" target="_blank">codec/Option.ts:67</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L67" target="_blank">codec/Option.ts:67</a></em></p>
<p><em><strong>description</strong></em>: Checks if the Option has a value</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
<p><a id="value"></a></p>
<h2 id="value">value</h2>
<p>getvalue(): <a href="../interfaces/_types_.codec.md">Codec</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L74" target="_blank">codec/Option.ts:74</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L74" target="_blank">codec/Option.ts:74</a></em></p>
<p><em><strong>description</strong></em>: The actual value for the Option</p>
<p><strong>Returns:</strong> <a href="../interfaces/_types_.codec.md">Codec</a></p>
<hr>
@@ -2207,7 +2207,7 @@
<h2 id="eq">eq</h2>
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L81" target="_blank">codec/Option.ts:81</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L81" target="_blank">codec/Option.ts:81</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2230,7 +2230,7 @@
<h2 id="tohex">toHex</h2>
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L92" target="_blank">codec/Option.ts:92</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L92" target="_blank">codec/Option.ts:92</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2238,7 +2238,7 @@
<h2 id="tojson">toJSON</h2>
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L99" target="_blank">codec/Option.ts:99</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L99" target="_blank">codec/Option.ts:99</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2246,7 +2246,7 @@
<h2 id="tostring">toString</h2>
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L106" target="_blank">codec/Option.ts:106</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L106" target="_blank">codec/Option.ts:106</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2254,7 +2254,7 @@
<h2 id="tou8a">toU8a</h2>
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L114" target="_blank">codec/Option.ts:114</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L114" target="_blank">codec/Option.ts:114</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2280,14 +2280,14 @@
<p><a id="unwrap"></a></p>
<h2 id="unwrap">unwrap</h2>
<p>&#x25B8; <strong>unwrap</strong>(): <code>T</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L132" target="_blank">codec/Option.ts:132</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L132" target="_blank">codec/Option.ts:132</a></em></p>
<p><em><strong>description</strong></em>: Returns the value that the Option represents (if available)</p>
<p><strong>Returns:</strong> <code>T</code></p>
<hr>
<p><a id="decodeoption"></a></p>
<h2 id="static-decodeoption"><code>&lt;Static&gt;</code> decodeOption</h2>
<p>&#x25B8; <strong>decodeOption</strong>&lt;<code>O</code>&gt;(Type: <em><a href="../modules/_types_.md#constructor">Constructor</a></em>, value?: <em><code>any</code></em>): <a href="../interfaces/_types_.codec.md">Codec</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L26" target="_blank">codec/Option.ts:26</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L26" target="_blank">codec/Option.ts:26</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="o">O</h4>
<p><strong>Parameters:</strong></p>
@@ -2314,7 +2314,7 @@
<p><a id="with"></a></p>
<h2 id="static-with"><code>&lt;Static&gt;</code> with</h2>
<p>&#x25B8; <strong>with</strong>&lt;<code>O</code>&gt;(Type: <em><a href="../modules/_types_.md#constructor">Constructor</a></em>): <a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_option_.option.html">Option</a>&lt;<code>O</code>&gt;&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L41" target="_blank">codec/Option.ts:41</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L41" target="_blank">codec/Option.ts:41</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="o---codec">O : <a href="../interfaces/_types_.codec.md">Codec</a></h4>
<p><strong>Parameters:</strong></p>
@@ -2377,7 +2377,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.17","depth":1,"next":{"title":"hidden","level":"4.18","depth":1,"path":"types/classes/_codec_set_.set.md","ref":"types/classes/_codec_set_.set.md","articles":[]},"previous":{"title":"hidden","level":"4.16","depth":1,"path":"types/classes/_codec_enumtype_.enumtype.md","ref":"types/classes/_codec_enumtype_.enumtype.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_option_.option.md","mtime":"2019-01-25T10:38:57.040Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.17","depth":1,"next":{"title":"hidden","level":"4.18","depth":1,"path":"types/classes/_codec_set_.set.md","ref":"types/classes/_codec_set_.set.md","articles":[]},"previous":{"title":"hidden","level":"4.16","depth":1,"path":"types/classes/_codec_enumtype_.enumtype.md","ref":"types/classes/_codec_enumtype_.enumtype.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_option_.option.md","mtime":"2019-01-26T15:31:28.313Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_codec_option_.option.md
+13 -13
View File
@@ -26,7 +26,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Option.ts:19](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L19)*
*Defined in [codec/Option.ts:19](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L19)*
**Parameters:**
@@ -47,7 +47,7 @@ ___
getencodedLength(): `number`
*Defined in [codec/Option.ts:52](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L52)*
*Defined in [codec/Option.ts:52](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L52)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -60,7 +60,7 @@ ___
getisNone(): `boolean`
*Defined in [codec/Option.ts:60](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L60)*
*Defined in [codec/Option.ts:60](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L60)*
*__description__*: Checks if the Option has no value
@@ -73,7 +73,7 @@ ___
getisSome(): `boolean`
*Defined in [codec/Option.ts:67](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L67)*
*Defined in [codec/Option.ts:67](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L67)*
*__description__*: Checks if the Option has a value
@@ -86,7 +86,7 @@ ___
getvalue(): [Codec](../interfaces/_types_.codec.md)
*Defined in [codec/Option.ts:74](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L74)*
*Defined in [codec/Option.ts:74](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L74)*
*__description__*: The actual value for the Option
@@ -104,7 +104,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)*
*Defined in [codec/Option.ts:81](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L81)*
*Defined in [codec/Option.ts:81](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L81)*
*__description__*: Compares the value of the input to see if there is a match
@@ -125,7 +125,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/Option.ts:92](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L92)*
*Defined in [codec/Option.ts:92](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L92)*
*__description__*: Returns a hex string representation of the value
@@ -140,7 +140,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/Option.ts:99](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L99)*
*Defined in [codec/Option.ts:99](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L99)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -155,7 +155,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [codec/Option.ts:106](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L106)*
*Defined in [codec/Option.ts:106](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L106)*
*__description__*: Returns the string representation of the value
@@ -170,7 +170,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [codec/Option.ts:114](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L114)*
*Defined in [codec/Option.ts:114](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L114)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -189,7 +189,7 @@ ___
▸ **unwrap**(): `T`
*Defined in [codec/Option.ts:132](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L132)*
*Defined in [codec/Option.ts:132](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L132)*
*__description__*: Returns the value that the Option represents (if available)
@@ -202,7 +202,7 @@ ___
▸ **decodeOption**<`O`>(Type: *[Constructor](../modules/_types_.md#constructor)*, value?: *`any`*): [Codec](../interfaces/_types_.codec.md)
*Defined in [codec/Option.ts:26](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L26)*
*Defined in [codec/Option.ts:26](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L26)*
**Type parameters:**
@@ -223,7 +223,7 @@ ___
▸ **with**<`O`>(Type: *[Constructor](../modules/_types_.md#constructor)*): [Constructor](../modules/_types_.md#constructor)<[Option](_codec_option_.option.md)<`O`>>
*Defined in [codec/Option.ts:41](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Option.ts#L41)*
*Defined in [codec/Option.ts:41](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Option.ts#L41)*
**Type parameters:**
docs/types/classes/_codec_set_.set.html
+13 -13
View File
@@ -2149,7 +2149,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Set</strong>(setValues: <em><code>SetValues</code></em>, value?: <em><code>Array</code>&lt;<code>string</code>&gt; | <code>Uint8Array</code> | <code>number</code></em>): <a href="_codec_set_.set.html">Set</a></p>
<p><em>Overrides <a href="_codec_base_.base.html">Base</a>.<a href="_codec_base_.base.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L23" target="_blank">codec/Set.ts:23</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L23" target="_blank">codec/Set.ts:23</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2177,28 +2177,28 @@
<p><a id="encodedlength"></a></p>
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L73" target="_blank">codec/Set.ts:73</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L73" target="_blank">codec/Set.ts:73</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="isempty"></a></p>
<h2 id="isempty">isEmpty</h2>
<p>getisEmpty(): <code>boolean</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L80" target="_blank">codec/Set.ts:80</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L80" target="_blank">codec/Set.ts:80</a></em></p>
<p><em><strong>description</strong></em>: true is the Set contains no values</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
<p><a id="valueencoded"></a></p>
<h2 id="valueencoded">valueEncoded</h2>
<p>getvalueEncoded(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L94" target="_blank">codec/Set.ts:94</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L94" target="_blank">codec/Set.ts:94</a></em></p>
<p><em><strong>description</strong></em>: The encoded value for the set members</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="values"></a></p>
<h2 id="values">values</h2>
<p>getvalues(): <code>Array</code>&lt;<code>string</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L87" target="_blank">codec/Set.ts:87</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L87" target="_blank">codec/Set.ts:87</a></em></p>
<p><em><strong>description</strong></em>: The actual set values as a Array</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<code>string</code>&gt;</p>
<hr>
@@ -2207,7 +2207,7 @@
<h2 id="eq">eq</h2>
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L101" target="_blank">codec/Set.ts:101</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L101" target="_blank">codec/Set.ts:101</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2230,7 +2230,7 @@
<h2 id="tohex">toHex</h2>
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L117" target="_blank">codec/Set.ts:117</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L117" target="_blank">codec/Set.ts:117</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2238,7 +2238,7 @@
<h2 id="tojson">toJSON</h2>
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L124" target="_blank">codec/Set.ts:124</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L124" target="_blank">codec/Set.ts:124</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2246,7 +2246,7 @@
<h2 id="tostring">toString</h2>
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L131" target="_blank">codec/Set.ts:131</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L131" target="_blank">codec/Set.ts:131</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2254,7 +2254,7 @@
<h2 id="tou8a">toU8a</h2>
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L139" target="_blank">codec/Set.ts:139</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L139" target="_blank">codec/Set.ts:139</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2280,7 +2280,7 @@
<p><a id="decodeset"></a></p>
<h2 id="static-decodeset"><code>&lt;Static&gt;</code> decodeSet</h2>
<p>&#x25B8; <strong>decodeSet</strong>(setValues: <em><code>SetValues</code></em>, value?: <em><code>Array</code>&lt;<code>string</code>&gt; | <code>Uint8Array</code> | <code>number</code></em>): <code>Array</code>&lt;<code>string</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L33" target="_blank">codec/Set.ts:33</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L33" target="_blank">codec/Set.ts:33</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2310,7 +2310,7 @@
<p><a id="encodeset"></a></p>
<h2 id="static-encodeset"><code>&lt;Static&gt;</code> encodeSet</h2>
<p>&#x25B8; <strong>encodeSet</strong>(setValues: <em><code>SetValues</code></em>, value: <em><code>Array</code>&lt;<code>string</code>&gt;</em>): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L64" target="_blank">codec/Set.ts:64</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L64" target="_blank">codec/Set.ts:64</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2375,7 +2375,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.18","depth":1,"next":{"title":"hidden","level":"4.19","depth":1,"path":"types/classes/_codec_struct_.struct.md","ref":"types/classes/_codec_struct_.struct.md","articles":[]},"previous":{"title":"hidden","level":"4.17","depth":1,"path":"types/classes/_codec_option_.option.md","ref":"types/classes/_codec_option_.option.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_set_.set.md","mtime":"2019-01-25T10:38:57.064Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.18","depth":1,"next":{"title":"hidden","level":"4.19","depth":1,"path":"types/classes/_codec_struct_.struct.md","ref":"types/classes/_codec_struct_.struct.md","articles":[]},"previous":{"title":"hidden","level":"4.17","depth":1,"path":"types/classes/_codec_option_.option.md","ref":"types/classes/_codec_option_.option.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_set_.set.md","mtime":"2019-01-26T15:31:28.329Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_codec_set_.set.md
+12 -12
View File
@@ -24,7 +24,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Set.ts:23](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L23)*
*Defined in [codec/Set.ts:23](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L23)*
**Parameters:**
@@ -45,7 +45,7 @@ ___
getencodedLength(): `number`
*Defined in [codec/Set.ts:73](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L73)*
*Defined in [codec/Set.ts:73](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L73)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -58,7 +58,7 @@ ___
getisEmpty(): `boolean`
*Defined in [codec/Set.ts:80](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L80)*
*Defined in [codec/Set.ts:80](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L80)*
*__description__*: true is the Set contains no values
@@ -71,7 +71,7 @@ ___
getvalueEncoded(): `number`
*Defined in [codec/Set.ts:94](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L94)*
*Defined in [codec/Set.ts:94](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L94)*
*__description__*: The encoded value for the set members
@@ -84,7 +84,7 @@ ___
getvalues(): `Array`<`string`>
*Defined in [codec/Set.ts:87](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L87)*
*Defined in [codec/Set.ts:87](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L87)*
*__description__*: The actual set values as a Array
@@ -102,7 +102,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)*
*Defined in [codec/Set.ts:101](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L101)*
*Defined in [codec/Set.ts:101](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L101)*
*__description__*: Compares the value of the input to see if there is a match
@@ -123,7 +123,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/Set.ts:117](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L117)*
*Defined in [codec/Set.ts:117](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L117)*
*__description__*: Returns a hex string representation of the value
@@ -138,7 +138,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/Set.ts:124](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L124)*
*Defined in [codec/Set.ts:124](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L124)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -153,7 +153,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [codec/Set.ts:131](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L131)*
*Defined in [codec/Set.ts:131](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L131)*
*__description__*: Returns the string representation of the value
@@ -168,7 +168,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [codec/Set.ts:139](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L139)*
*Defined in [codec/Set.ts:139](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L139)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -187,7 +187,7 @@ ___
▸ **decodeSet**(setValues: *`SetValues`*, value?: *`Array`<`string`> | `Uint8Array` | `number`*): `Array`<`string`>
*Defined in [codec/Set.ts:33](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L33)*
*Defined in [codec/Set.ts:33](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L33)*
**Parameters:**
@@ -205,7 +205,7 @@ ___
▸ **encodeSet**(setValues: *`SetValues`*, value: *`Array`<`string`>*): `number`
*Defined in [codec/Set.ts:64](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Set.ts#L64)*
*Defined in [codec/Set.ts:64](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Set.ts#L64)*
**Parameters:**
docs/types/classes/_codec_struct_.struct.html
+29 -26
View File
@@ -2147,14 +2147,14 @@
<p><strong>&#x21B3; Struct</strong></p>
<p>&#x21B3; <a href="_attestedcandidate_.candidatereceipt.md">CandidateReceipt</a></p>
<p>&#x21B3; <a href="_attestedcandidate_.attestedcandidate.md">AttestedCandidate</a></p>
<p>&#x21B3; <a href="_metadata_modules_.functionargumentmetadata.md">FunctionArgumentMetadata</a></p>
<p>&#x21B3; <a href="_metadata_modules_.functionmetadata.md">FunctionMetadata</a></p>
<p>&#x21B3; <a href="_metadata_modules_.callmetadata.md">CallMetadata</a></p>
<p>&#x21B3; <a href="_metadata_modules_.modulemetadata.md">ModuleMetadata</a></p>
<p>&#x21B3; <a href="_metadata_modules_.storagefunctiontype_map.md">StorageFunctionType$Map</a></p>
<p>&#x21B3; <a href="_metadata_modules_.storagefunctionmetadata.md">StorageFunctionMetadata</a></p>
<p>&#x21B3; <a href="_metadata_modules_.storagemetadata.md">StorageMetadata</a></p>
<p>&#x21B3; <a href="_metadata_modules_.runtimemodulemetadata.md">RuntimeModuleMetadata</a></p>
<p>&#x21B3; <a href="_metadata_v0_modules_.functionargumentmetadata.md">FunctionArgumentMetadata</a></p>
<p>&#x21B3; <a href="_metadata_v0_modules_.functionmetadata.md">FunctionMetadata</a></p>
<p>&#x21B3; <a href="_metadata_v0_modules_.callmetadata.md">CallMetadata</a></p>
<p>&#x21B3; <a href="_metadata_v0_modules_.modulemetadata.md">ModuleMetadata</a></p>
<p>&#x21B3; <a href="_metadata_v0_modules_.storagefunctiontype_map.md">StorageFunctionType$Map</a></p>
<p>&#x21B3; <a href="_metadata_v0_modules_.storagefunctionmetadata.md">StorageFunctionMetadata</a></p>
<p>&#x21B3; <a href="_metadata_v0_modules_.storagemetadata.md">StorageMetadata</a></p>
<p>&#x21B3; <a href="_metadata_v0_modules_.runtimemodulemetadata.md">RuntimeModuleMetadata</a></p>
<p>&#x21B3; <a href="_method_.method.html">Method</a></p>
<p>&#x21B3; <a href="_signaturepayload_.signaturepayload.html">SignaturePayload</a></p>
<p>&#x21B3; <a href="_extrinsicsignature_.extrinsicsignature.html">ExtrinsicSignature</a></p>
@@ -2162,13 +2162,16 @@
<p>&#x21B3; <a href="_digest_.digest.html">Digest</a></p>
<p>&#x21B3; <a href="_header_.header.html">Header</a></p>
<p>&#x21B3; <a href="_block_.block.html">Block</a></p>
<p>&#x21B3; <a href="_metadata_calls_.outerdispatchcall.md">OuterDispatchCall</a></p>
<p>&#x21B3; <a href="_metadata_calls_.outerdispatchmetadata.md">OuterDispatchMetadata</a></p>
<p>&#x21B3; <a href="_metadata_events_.eventmetadata.md">EventMetadata</a></p>
<p>&#x21B3; <a href="_metadata_events_.outereventmetadata.md">OuterEventMetadata</a></p>
<p>&#x21B3; <a href="_metadata_index_.metadata.md">Metadata</a></p>
<p>&#x21B3; <a href="_metadata_v0_calls_.outerdispatchcall.md">OuterDispatchCall</a></p>
<p>&#x21B3; <a href="_metadata_v0_calls_.outerdispatchmetadata.md">OuterDispatchMetadata</a></p>
<p>&#x21B3; <a href="_metadata_v0_events_.eventmetadata.md">EventMetadata</a></p>
<p>&#x21B3; <a href="_metadata_v0_events_.outereventmetadata.md">OuterEventMetadata</a></p>
<p>&#x21B3; <a href="_metadata_v0_index_.metadatav0.md">MetadataV0</a></p>
<p>&#x21B3; <a href="_event_.event.html">Event</a></p>
<p>&#x21B3; <a href="_eventrecord_.eventrecord.html">EventRecord</a></p>
<p>&#x21B3; <a href="_metadata_v1_outerdispatch_.outerdispatchcall.md">OuterDispatchCall</a></p>
<p>&#x21B3; <a href="_metadata_v1_index_.metadatav1.md">MetadataV1</a></p>
<p>&#x21B3; <a href="_metadata_metadataversioned_.metadataversioned.md">MetadataVersioned</a></p>
<p>&#x21B3; <a href="_health_.health.md">Health</a></p>
<p>&#x21B3; <a href="_keyvalue_.keyvalue.html">KeyValue</a></p>
<p>&#x21B3; <a href="_misbehaviorreport_.bftatreport.html">BftAtReport</a></p>
@@ -2191,7 +2194,7 @@
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Struct</strong>(Types: <em><code>S</code></em>, value?: <em><code>V</code> | <code>Map</code>&lt;<code>any</code>, <code>any</code>&gt; | <code>Array</code>&lt;<code>any</code>&gt;</em>, jsonMap?: <em><code>Map</code>&lt;<code>keyof S</code>, <code>string</code>&gt;</em>): <a href="_codec_struct_.struct.html">Struct</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L31" target="_blank">codec/Struct.ts:31</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L31" target="_blank">codec/Struct.ts:31</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2233,14 +2236,14 @@
<p><a id="type"></a></p>
<h2 id="type">Type</h2>
<p>getType(): <code>E</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L142" target="_blank">codec/Struct.ts:142</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L142" target="_blank">codec/Struct.ts:142</a></em></p>
<p><em><strong>description</strong></em>: Returns the Type description to sthe structure</p>
<p><strong>Returns:</strong> <code>E</code></p>
<hr>
<p><a id="encodedlength"></a></p>
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L149" target="_blank">codec/Struct.ts:149</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L149" target="_blank">codec/Struct.ts:149</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2249,7 +2252,7 @@
<h2 id="eq">eq</h2>
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L158" target="_blank">codec/Struct.ts:158</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L158" target="_blank">codec/Struct.ts:158</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2272,7 +2275,7 @@
<h2 id="get">get</h2>
<p>&#x25B8; <strong>get</strong>(name: <em><code>keyof S</code></em>): <a href="../interfaces/_types_.codec.md">Codec</a> | <code>undefined</code></p>
<p><em>Overrides Map.get</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L166" target="_blank">codec/Struct.ts:166</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L166" target="_blank">codec/Struct.ts:166</a></em></p>
<p><em><strong>description</strong></em>: Returns a specific names entry in the structure</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2296,7 +2299,7 @@
<p><a id="getatindex"></a></p>
<h2 id="getatindex">getAtIndex</h2>
<p>&#x25B8; <strong>getAtIndex</strong>(index: <em><code>number</code></em>): <a href="../interfaces/_types_.codec.md">Codec</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L173" target="_blank">codec/Struct.ts:173</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L173" target="_blank">codec/Struct.ts:173</a></em></p>
<p><em><strong>description</strong></em>: Returns the values of a member at a specific index (Rather use get(name) for performance)</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2318,7 +2321,7 @@
<p><a id="toarray"></a></p>
<h2 id="toarray">toArray</h2>
<p>&#x25B8; <strong>toArray</strong>(): <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L180" target="_blank">codec/Struct.ts:180</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L180" target="_blank">codec/Struct.ts:180</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to an standard JavaScript Array</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<hr>
@@ -2326,7 +2329,7 @@
<h2 id="tohex">toHex</h2>
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L187" target="_blank">codec/Struct.ts:187</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L187" target="_blank">codec/Struct.ts:187</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2334,7 +2337,7 @@
<h2 id="tojson">toJSON</h2>
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L194" target="_blank">codec/Struct.ts:194</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L194" target="_blank">codec/Struct.ts:194</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2342,7 +2345,7 @@
<h2 id="tostring">toString</h2>
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L208" target="_blank">codec/Struct.ts:208</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L208" target="_blank">codec/Struct.ts:208</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2350,7 +2353,7 @@
<h2 id="tou8a">toU8a</h2>
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L216" target="_blank">codec/Struct.ts:216</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L216" target="_blank">codec/Struct.ts:216</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2376,7 +2379,7 @@
<p><a id="with"></a></p>
<h2 id="static-with"><code>&lt;Static&gt;</code> with</h2>
<p>&#x25B8; <strong>with</strong>&lt;<code>S</code>&gt;(Types: <em><code>S</code></em>): <a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_struct_.struct.html">Struct</a>&lt;<code>S</code>&gt;&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L122" target="_blank">codec/Struct.ts:122</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L122" target="_blank">codec/Struct.ts:122</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="s---constructordef">S : <a href="../modules/_types_.md#constructordef">ConstructorDef</a></h4>
<p><strong>Parameters:</strong></p>
@@ -2439,7 +2442,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.19","depth":1,"next":{"title":"hidden","level":"4.20","depth":1,"path":"types/classes/_codec_tuple_.tuple.md","ref":"types/classes/_codec_tuple_.tuple.md","articles":[]},"previous":{"title":"hidden","level":"4.18","depth":1,"path":"types/classes/_codec_set_.set.md","ref":"types/classes/_codec_set_.set.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_struct_.struct.md","mtime":"2019-01-25T10:38:57.096Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.19","depth":1,"next":{"title":"hidden","level":"4.20","depth":1,"path":"types/classes/_codec_tuple_.tuple.md","ref":"types/classes/_codec_tuple_.tuple.md","articles":[]},"previous":{"title":"hidden","level":"4.18","depth":1,"path":"types/classes/_codec_set_.set.md","ref":"types/classes/_codec_set_.set.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_struct_.struct.md","mtime":"2019-01-26T15:31:28.365Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_codec_struct_.struct.md
+31 -25
View File
@@ -19,21 +19,21 @@
↳ [AttestedCandidate](_attestedcandidate_.attestedcandidate.md)
↳ [FunctionArgumentMetadata](_metadata_modules_.functionargumentmetadata.md)
↳ [FunctionArgumentMetadata](_metadata_v0_modules_.functionargumentmetadata.md)
↳ [FunctionMetadata](_metadata_modules_.functionmetadata.md)
↳ [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md)
↳ [CallMetadata](_metadata_modules_.callmetadata.md)
↳ [CallMetadata](_metadata_v0_modules_.callmetadata.md)
↳ [ModuleMetadata](_metadata_modules_.modulemetadata.md)
↳ [ModuleMetadata](_metadata_v0_modules_.modulemetadata.md)
↳ [StorageFunctionType$Map](_metadata_modules_.storagefunctiontype_map.md)
↳ [StorageFunctionType$Map](_metadata_v0_modules_.storagefunctiontype_map.md)
↳ [StorageFunctionMetadata](_metadata_modules_.storagefunctionmetadata.md)
↳ [StorageFunctionMetadata](_metadata_v0_modules_.storagefunctionmetadata.md)
↳ [StorageMetadata](_metadata_modules_.storagemetadata.md)
↳ [StorageMetadata](_metadata_v0_modules_.storagemetadata.md)
↳ [RuntimeModuleMetadata](_metadata_modules_.runtimemodulemetadata.md)
↳ [RuntimeModuleMetadata](_metadata_v0_modules_.runtimemodulemetadata.md)
↳ [Method](_method_.method.md)
@@ -49,20 +49,26 @@
↳ [Block](_block_.block.md)
↳ [OuterDispatchCall](_metadata_calls_.outerdispatchcall.md)
↳ [OuterDispatchCall](_metadata_v0_calls_.outerdispatchcall.md)
↳ [OuterDispatchMetadata](_metadata_calls_.outerdispatchmetadata.md)
↳ [OuterDispatchMetadata](_metadata_v0_calls_.outerdispatchmetadata.md)
↳ [EventMetadata](_metadata_events_.eventmetadata.md)
↳ [EventMetadata](_metadata_v0_events_.eventmetadata.md)
↳ [OuterEventMetadata](_metadata_events_.outereventmetadata.md)
↳ [OuterEventMetadata](_metadata_v0_events_.outereventmetadata.md)
↳ [Metadata](_metadata_index_.metadata.md)
↳ [MetadataV0](_metadata_v0_index_.metadatav0.md)
↳ [Event](_event_.event.md)
↳ [EventRecord](_eventrecord_.eventrecord.md)
↳ [OuterDispatchCall](_metadata_v1_outerdispatch_.outerdispatchcall.md)
↳ [MetadataV1](_metadata_v1_index_.metadatav1.md)
↳ [MetadataVersioned](_metadata_metadataversioned_.metadataversioned.md)
↳ [Health](_health_.health.md)
↳ [KeyValue](_keyvalue_.keyvalue.md)
@@ -103,7 +109,7 @@
⊕ **new Struct**(Types: *`S`*, value?: *`V` | `Map`<`any`, `any`> | `Array`<`any`>*, jsonMap?: *`Map`<`keyof S`, `string`>*): [Struct](_codec_struct_.struct.md)
*Defined in [codec/Struct.ts:31](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L31)*
*Defined in [codec/Struct.ts:31](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L31)*
**Parameters:**
@@ -137,7 +143,7 @@ ___
getType(): `E`
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L142)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L142)*
*__description__*: Returns the Type description to sthe structure
@@ -150,7 +156,7 @@ ___
getencodedLength(): `number`
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L149)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L149)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -168,7 +174,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L158)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L158)*
*__description__*: Compares the value of the input to see if there is a match
@@ -189,7 +195,7 @@ ___
*Overrides Map.get*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L166)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Returns a specific names entry in the structure
@@ -208,7 +214,7 @@ ___
▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md)
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L173)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L173)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -227,7 +233,7 @@ ___
▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)>
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L180)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -242,7 +248,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L187)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L187)*
*__description__*: Returns a hex string representation of the value
@@ -257,7 +263,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L194)*
*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L194)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -272,7 +278,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L208)*
*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L208)*
*__description__*: Returns the string representation of the value
@@ -287,7 +293,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L216)*
*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L216)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -306,7 +312,7 @@ ___
▸ **with**<`S`>(Types: *`S`*): [Constructor](../modules/_types_.md#constructor)<[Struct](_codec_struct_.struct.md)<`S`>>
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L122)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L122)*
**Type parameters:**
docs/types/classes/_codec_tuple_.tuple.html
+14 -14
View File
@@ -2147,7 +2147,7 @@
<p>&#x21B3; <a href="_bft_.bftauthoritysignature.html">BftAuthoritySignature</a></p>
<p>&#x21B3; <a href="_bft_.bfthashsignature.html">BftHashSignature</a></p>
<p>&#x21B3; <a href="_digest_.seal.html">Seal</a></p>
<p>&#x21B3; <a href="_metadata_events_.outereventmetadataevent.md">OuterEventMetadataEvent</a></p>
<p>&#x21B3; <a href="_metadata_v0_events_.outereventmetadataevent.md">OuterEventMetadataEvent</a></p>
<p>&#x21B3; <a href="_event_.eventdata.html">EventData</a></p>
<p>&#x21B3; <a href="_inherentofflinereport_.inherentofflinereport.md">InherentOfflineReport</a></p>
<p>&#x21B3; <a href="_keyvalue_.keyvalueoption.html">KeyValueOption</a></p>
@@ -2163,7 +2163,7 @@
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Tuple</strong>(Types: <em><code>TupleConstructors</code></em>, value: <em><code>any</code></em>): <a href="_codec_tuple_.tuple.html">Tuple</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L22" target="_blank">codec/Tuple.ts:22</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L22" target="_blank">codec/Tuple.ts:22</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2195,14 +2195,14 @@
<p><a id="types"></a></p>
<h2 id="types">Types</h2>
<p>getTypes(): <code>Array</code>&lt;<code>string</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L68" target="_blank">codec/Tuple.ts:68</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L68" target="_blank">codec/Tuple.ts:68</a></em></p>
<p><em><strong>description</strong></em>: The types definition of the tuple</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<code>string</code>&gt;</p>
<hr>
<p><a id="encodedlength"></a></p>
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L59" target="_blank">codec/Tuple.ts:59</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L59" target="_blank">codec/Tuple.ts:59</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2211,7 +2211,7 @@
<h2 id="eq">eq</h2>
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L77" target="_blank">codec/Tuple.ts:77</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L77" target="_blank">codec/Tuple.ts:77</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2234,7 +2234,7 @@
<h2 id="filter">filter</h2>
<p>&#x25B8; <strong>filter</strong>(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><em>Overrides Array.filter</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L133" target="_blank">codec/Tuple.ts:133</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L133" target="_blank">codec/Tuple.ts:133</a></em></p>
<p><em><strong>description</strong></em>: Filters the array with the callback</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2264,7 +2264,7 @@
<h2 id="map">map</h2>
<p>&#x25B8; <strong>map</strong>&lt;<code>U</code>&gt;(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code>&lt;<code>U</code>&gt;</p>
<p><em>Overrides Array.map</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L142" target="_blank">codec/Tuple.ts:142</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L142" target="_blank">codec/Tuple.ts:142</a></em></p>
<p><em><strong>description</strong></em>: Maps the array with the callback</p>
<p><strong>Type parameters:</strong></p>
<h4 id="u">U</h4>
@@ -2295,7 +2295,7 @@
<p><a id="toarray"></a></p>
<h2 id="toarray">toArray</h2>
<p>&#x25B8; <strong>toArray</strong>(): <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L84" target="_blank">codec/Tuple.ts:84</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L84" target="_blank">codec/Tuple.ts:84</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to an standard JavaScript Array</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<hr>
@@ -2303,7 +2303,7 @@
<h2 id="tohex">toHex</h2>
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L91" target="_blank">codec/Tuple.ts:91</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L91" target="_blank">codec/Tuple.ts:91</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2311,7 +2311,7 @@
<h2 id="tojson">toJSON</h2>
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L98" target="_blank">codec/Tuple.ts:98</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L98" target="_blank">codec/Tuple.ts:98</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2320,7 +2320,7 @@
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Overrides Array.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L107" target="_blank">codec/Tuple.ts:107</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L107" target="_blank">codec/Tuple.ts:107</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2328,7 +2328,7 @@
<h2 id="tou8a">toU8a</h2>
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L116" target="_blank">codec/Tuple.ts:116</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L116" target="_blank">codec/Tuple.ts:116</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2354,7 +2354,7 @@
<p><a id="with"></a></p>
<h2 id="static-with"><code>&lt;Static&gt;</code> with</h2>
<p>&#x25B8; <strong>with</strong>(Types: <em><code>TupleConstructors</code></em>): <a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_tuple_.tuple.html">Tuple</a>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L48" target="_blank">codec/Tuple.ts:48</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L48" target="_blank">codec/Tuple.ts:48</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2415,7 +2415,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.20","depth":1,"next":{"title":"hidden","level":"4.21","depth":1,"path":"types/classes/_codec_typeregistry_.typeregistry.md","ref":"types/classes/_codec_typeregistry_.typeregistry.md","articles":[]},"previous":{"title":"hidden","level":"4.19","depth":1,"path":"types/classes/_codec_struct_.struct.md","ref":"types/classes/_codec_struct_.struct.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_tuple_.tuple.md","mtime":"2019-01-25T10:38:57.124Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.20","depth":1,"next":{"title":"hidden","level":"4.21","depth":1,"path":"types/classes/_codec_typeregistry_.typeregistry.md","ref":"types/classes/_codec_typeregistry_.typeregistry.md","articles":[]},"previous":{"title":"hidden","level":"4.19","depth":1,"path":"types/classes/_codec_struct_.struct.md","ref":"types/classes/_codec_struct_.struct.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_tuple_.tuple.md","mtime":"2019-01-26T15:31:28.389Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_codec_tuple_.tuple.md
+13 -13
View File
@@ -24,7 +24,7 @@
↳ [Seal](_digest_.seal.md)
↳ [OuterEventMetadataEvent](_metadata_events_.outereventmetadataevent.md)
↳ [OuterEventMetadataEvent](_metadata_v0_events_.outereventmetadataevent.md)
↳ [EventData](_event_.eventdata.md)
@@ -51,7 +51,7 @@
⊕ **new Tuple**(Types: *`TupleConstructors`*, value: *`any`*): [Tuple](_codec_tuple_.tuple.md)
*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L22)*
*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L22)*
**Parameters:**
@@ -84,7 +84,7 @@ ___
getTypes(): `Array`<`string`>
*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L68)*
*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L68)*
*__description__*: The types definition of the tuple
@@ -97,7 +97,7 @@ ___
getencodedLength(): `number`
*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L59)*
*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L59)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -115,7 +115,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)*
*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L77)*
*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L77)*
*__description__*: Compares the value of the input to see if there is a match
@@ -136,7 +136,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L133)*
*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L133)*
*__description__*: Filters the array with the callback
@@ -158,7 +158,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L142)*
*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L142)*
*__description__*: Maps the array with the callback
@@ -181,7 +181,7 @@ ___
▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)>
*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L84)*
*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L84)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -196,7 +196,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L91)*
*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L91)*
*__description__*: Returns a hex string representation of the value
@@ -211,7 +211,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L98)*
*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L98)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -228,7 +228,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L107)*
*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L107)*
*__description__*: Returns the string representation of the value
@@ -243,7 +243,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L116)*
*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L116)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -262,7 +262,7 @@ ___
▸ **with**(Types: *`TupleConstructors`*): [Constructor](../modules/_types_.md#constructor)<[Tuple](_codec_tuple_.tuple.md)>
*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L48)*
*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L48)*
**Parameters:**
docs/types/classes/_codec_typeregistry_.typeregistry.html
+5 -5
View File
@@ -2141,13 +2141,13 @@
<p><a id="defaultregistry"></a></p>
<h2 id="static-defaultregistry"><code>&lt;Static&gt;</code> defaultRegistry</h2>
<p><strong>&#x25CF; defaultRegistry</strong>: <em><a href="_codec_typeregistry_.typeregistry.html">TypeRegistry</a></em> = new TypeRegistry()</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/typeRegistry.ts#L16" target="_blank">codec/typeRegistry.ts:16</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/typeRegistry.ts#L16" target="_blank">codec/typeRegistry.ts:16</a></em></p>
<hr>
<h1 id="methods">Methods</h1>
<p><a id="get"></a></p>
<h2 id="get">get</h2>
<p>&#x25B8; <strong>get</strong>(name: <em><code>string</code></em>): <a href="../modules/_types_.md#constructor">Constructor</a> | <code>undefined</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/typeRegistry.ts#L51" target="_blank">codec/typeRegistry.ts:51</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/typeRegistry.ts#L51" target="_blank">codec/typeRegistry.ts:51</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2169,7 +2169,7 @@
<h2 id="register">register</h2>
<p>&#x25B8; <strong>register</strong>(type: <em><a href="../modules/_types_.md#constructor">Constructor</a> | <code>ConstructorObj</code></em>): <code>void</code></p>
<p>&#x25B8; <strong>register</strong>(name: <em><code>string</code></em>, type: <em><a href="../modules/_types_.md#constructor">Constructor</a></em>): <code>void</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/typeRegistry.ts#L20" target="_blank">codec/typeRegistry.ts:20</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/typeRegistry.ts#L20" target="_blank">codec/typeRegistry.ts:20</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2187,7 +2187,7 @@
</tbody>
</table>
<p><strong>Returns:</strong> <code>void</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/typeRegistry.ts#L21" target="_blank">codec/typeRegistry.ts:21</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/typeRegistry.ts#L21" target="_blank">codec/typeRegistry.ts:21</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2252,7 +2252,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.21","depth":1,"next":{"title":"hidden","level":"4.22","depth":1,"path":"types/classes/_codec_u8a_.u8a.md","ref":"types/classes/_codec_u8a_.u8a.md","articles":[]},"previous":{"title":"hidden","level":"4.20","depth":1,"path":"types/classes/_codec_tuple_.tuple.md","ref":"types/classes/_codec_tuple_.tuple.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_typeregistry_.typeregistry.md","mtime":"2019-01-25T10:38:57.236Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.21","depth":1,"next":{"title":"hidden","level":"4.22","depth":1,"path":"types/classes/_codec_u8a_.u8a.md","ref":"types/classes/_codec_u8a_.u8a.md","articles":[]},"previous":{"title":"hidden","level":"4.20","depth":1,"path":"types/classes/_codec_tuple_.tuple.md","ref":"types/classes/_codec_tuple_.tuple.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_typeregistry_.typeregistry.md","mtime":"2019-01-26T15:31:28.481Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_codec_typeregistry_.typeregistry.md
+4 -4
View File
@@ -12,7 +12,7 @@
**● defaultRegistry**: *[TypeRegistry](_codec_typeregistry_.typeregistry.md)* = new TypeRegistry()
*Defined in [codec/typeRegistry.ts:16](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/typeRegistry.ts#L16)*
*Defined in [codec/typeRegistry.ts:16](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/typeRegistry.ts#L16)*
___
@@ -24,7 +24,7 @@ ___
▸ **get**(name: *`string`*): [Constructor](../modules/_types_.md#constructor) | `undefined`
*Defined in [codec/typeRegistry.ts:51](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/typeRegistry.ts#L51)*
*Defined in [codec/typeRegistry.ts:51](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/typeRegistry.ts#L51)*
**Parameters:**
@@ -43,7 +43,7 @@ ___
▸ **register**(name: *`string`*, type: *[Constructor](../modules/_types_.md#constructor)*): `void`
*Defined in [codec/typeRegistry.ts:20](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/typeRegistry.ts#L20)*
*Defined in [codec/typeRegistry.ts:20](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/typeRegistry.ts#L20)*
**Parameters:**
@@ -53,7 +53,7 @@ ___
**Returns:** `void`
*Defined in [codec/typeRegistry.ts:21](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/typeRegistry.ts#L21)*
*Defined in [codec/typeRegistry.ts:21](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/typeRegistry.ts#L21)*
**Parameters:**
docs/types/classes/_codec_u8a_.u8a.html
+11 -11
View File
@@ -2154,7 +2154,7 @@
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new U8a</strong>(value?: <em><a href="../modules/_types_.md#anyu8a">AnyU8a</a></em>): <a href="_codec_u8a_.u8a.html">U8a</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L18" target="_blank">codec/U8a.ts:18</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L18" target="_blank">codec/U8a.ts:18</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2182,14 +2182,14 @@
<p><a id="encodedlength"></a></p>
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="isempty"></a></p>
<h2 id="isempty">isEmpty</h2>
<p>getisEmpty(): <code>boolean</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em><strong>description</strong></em>: Returns true if the type wraps an empty/default all-0 value</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
@@ -2197,7 +2197,7 @@
<h2 id="length">length</h2>
<p>getlength(): <code>number</code></p>
<p><em>Overrides Uint8Array.length</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50" target="_blank">codec/U8a.ts:50</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50" target="_blank">codec/U8a.ts:50</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2206,7 +2206,7 @@
<h2 id="eq">eq</h2>
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L58" target="_blank">codec/U8a.ts:58</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L58" target="_blank">codec/U8a.ts:58</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2229,7 +2229,7 @@
<h2 id="subarray">subarray</h2>
<p>&#x25B8; <strong>subarray</strong>(begin: <em><code>number</code></em>, end?: <em><code>undefined</code> | <code>number</code></em>): <code>Uint8Array</code></p>
<p><em>Overrides Uint8Array.subarray</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73" target="_blank">codec/U8a.ts:73</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73" target="_blank">codec/U8a.ts:73</a></em></p>
<p><em><strong>description</strong></em>: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2260,7 +2260,7 @@
<h2 id="tohex">toHex</h2>
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80" target="_blank">codec/U8a.ts:80</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80" target="_blank">codec/U8a.ts:80</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2268,7 +2268,7 @@
<h2 id="tojson">toJSON</h2>
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L87" target="_blank">codec/U8a.ts:87</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L87" target="_blank">codec/U8a.ts:87</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2277,7 +2277,7 @@
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Overrides Uint8Array.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L94" target="_blank">codec/U8a.ts:94</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L94" target="_blank">codec/U8a.ts:94</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2285,7 +2285,7 @@
<h2 id="tou8a">toU8a</h2>
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L102" target="_blank">codec/U8a.ts:102</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L102" target="_blank">codec/U8a.ts:102</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2351,7 +2351,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.22","depth":1,"next":{"title":"hidden","level":"4.23","depth":1,"path":"types/classes/_codec_u8afixed_.u8afixed.md","ref":"types/classes/_codec_u8afixed_.u8afixed.md","articles":[]},"previous":{"title":"hidden","level":"4.21","depth":1,"path":"types/classes/_codec_typeregistry_.typeregistry.md","ref":"types/classes/_codec_typeregistry_.typeregistry.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_u8a_.u8a.md","mtime":"2019-01-25T10:38:57.152Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.22","depth":1,"next":{"title":"hidden","level":"4.23","depth":1,"path":"types/classes/_codec_u8afixed_.u8afixed.md","ref":"types/classes/_codec_u8afixed_.u8afixed.md","articles":[]},"previous":{"title":"hidden","level":"4.21","depth":1,"path":"types/classes/_codec_typeregistry_.typeregistry.md","ref":"types/classes/_codec_typeregistry_.typeregistry.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_u8a_.u8a.md","mtime":"2019-01-26T15:31:28.413Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_codec_u8a_.u8a.md
+10 -10
View File
@@ -33,7 +33,7 @@
⊕ **new U8a**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [U8a](_codec_u8a_.u8a.md)
*Defined in [codec/U8a.ts:18](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L18)*
*Defined in [codec/U8a.ts:18](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L18)*
**Parameters:**
@@ -65,7 +65,7 @@ ___
getencodedLength(): `number`
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -78,7 +78,7 @@ ___
getisEmpty(): `boolean`
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43)*
*__description__*: Returns true if the type wraps an empty/default all-0 value
@@ -93,7 +93,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50)*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50)*
*__description__*: The length of the value
@@ -111,7 +111,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L58)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L58)*
*__description__*: Compares the value of the input to see if there is a match
@@ -132,7 +132,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73)*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -154,7 +154,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80)*
*__description__*: Returns a hex string representation of the value
@@ -169,7 +169,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L87)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L87)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -186,7 +186,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L94)*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L94)*
*__description__*: Returns the string representation of the value
@@ -201,7 +201,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L102)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L102)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_codec_u8afixed_.u8afixed.html
+12 -12
View File
@@ -2157,7 +2157,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new U8aFixed</strong>(value?: <em><a href="../modules/_types_.md#anyu8a">AnyU8a</a></em>, bitLength?: <em><code>BitLength</code></em>): <a href="_codec_u8afixed_.u8afixed.html">U8aFixed</a></p>
<p><em>Overrides <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8aFixed.ts#L19" target="_blank">codec/U8aFixed.ts:19</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8aFixed.ts#L19" target="_blank">codec/U8aFixed.ts:19</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2187,7 +2187,7 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2195,7 +2195,7 @@
<h2 id="isempty">isEmpty</h2>
<p>getisEmpty(): <code>boolean</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#isempty">isEmpty</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em><strong>description</strong></em>: Returns true if the type wraps an empty/default all-0 value</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
@@ -2204,7 +2204,7 @@
<p>getlength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#length">length</a></em></p>
<p><em>Overrides Uint8Array.length</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50" target="_blank">codec/U8a.ts:50</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50" target="_blank">codec/U8a.ts:50</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2212,7 +2212,7 @@
<p><a id="bitlength"></a></p>
<h2 id="bitlength">bitLength</h2>
<p>&#x25B8; <strong>bitLength</strong>(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8aFixed.ts#L52" target="_blank">codec/U8aFixed.ts:52</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8aFixed.ts#L52" target="_blank">codec/U8aFixed.ts:52</a></em></p>
<p><em><strong>description</strong></em>: Returns the number of bits in the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2221,7 +2221,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L58" target="_blank">codec/U8a.ts:58</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L58" target="_blank">codec/U8a.ts:58</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2245,7 +2245,7 @@
<p>&#x25B8; <strong>subarray</strong>(begin: <em><code>number</code></em>, end?: <em><code>undefined</code> | <code>number</code></em>): <code>Uint8Array</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#subarray">subarray</a></em></p>
<p><em>Overrides Uint8Array.subarray</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73" target="_blank">codec/U8a.ts:73</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73" target="_blank">codec/U8a.ts:73</a></em></p>
<p><em><strong>description</strong></em>: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2277,7 +2277,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80" target="_blank">codec/U8a.ts:80</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80" target="_blank">codec/U8a.ts:80</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2286,7 +2286,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L87" target="_blank">codec/U8a.ts:87</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L87" target="_blank">codec/U8a.ts:87</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2296,7 +2296,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tostring">toString</a></em></p>
<p><em>Overrides Uint8Array.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L94" target="_blank">codec/U8a.ts:94</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L94" target="_blank">codec/U8a.ts:94</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2305,7 +2305,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L102" target="_blank">codec/U8a.ts:102</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L102" target="_blank">codec/U8a.ts:102</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2371,7 +2371,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.23","depth":1,"next":{"title":"hidden","level":"4.24","depth":1,"path":"types/classes/_codec_uint_.uint.md","ref":"types/classes/_codec_uint_.uint.md","articles":[]},"previous":{"title":"hidden","level":"4.22","depth":1,"path":"types/classes/_codec_u8a_.u8a.md","ref":"types/classes/_codec_u8a_.u8a.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_u8afixed_.u8afixed.md","mtime":"2019-01-25T10:38:57.192Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.23","depth":1,"next":{"title":"hidden","level":"4.24","depth":1,"path":"types/classes/_codec_uint_.uint.md","ref":"types/classes/_codec_uint_.uint.md","articles":[]},"previous":{"title":"hidden","level":"4.22","depth":1,"path":"types/classes/_codec_u8a_.u8a.md","ref":"types/classes/_codec_u8a_.u8a.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_u8afixed_.u8afixed.md","mtime":"2019-01-26T15:31:28.445Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_codec_u8afixed_.u8afixed.md
+11 -11
View File
@@ -39,7 +39,7 @@
*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)*
*Defined in [codec/U8aFixed.ts:19](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8aFixed.ts#L19)*
*Defined in [codec/U8aFixed.ts:19](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8aFixed.ts#L19)*
**Parameters:**
@@ -62,7 +62,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -77,7 +77,7 @@ getisEmpty(): `boolean`
*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43)*
*__description__*: Returns true if the type wraps an empty/default all-0 value
@@ -94,7 +94,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50)*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50)*
*__description__*: The length of the value
@@ -110,7 +110,7 @@ ___
▸ **bitLength**(): `number`
*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8aFixed.ts#L52)*
*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8aFixed.ts#L52)*
*__description__*: Returns the number of bits in the value
@@ -127,7 +127,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L58)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L58)*
*__description__*: Compares the value of the input to see if there is a match
@@ -150,7 +150,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73)*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -174,7 +174,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80)*
*__description__*: Returns a hex string representation of the value
@@ -191,7 +191,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L87)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L87)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -210,7 +210,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L94)*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L94)*
*__description__*: Returns the string representation of the value
@@ -227,7 +227,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L102)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L102)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_codec_uint_.uint.html
+4 -4
View File
@@ -2155,7 +2155,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new UInt</strong>(value?: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>, bitLength?: <em><a href="../modules/_codec_abstractint_.md#uintbitlength">UIntBitLength</a></em>, isHexJson?: <em><code>boolean</code></em>): <a href="_codec_uint_.uint.html">UInt</a></p>
<p><em>Overrides AbstractInt.__constructor</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/UInt.ts#L21" target="_blank">codec/UInt.ts:21</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/UInt.ts#L21" target="_blank">codec/UInt.ts:21</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2191,7 +2191,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Overrides AbstractInt.toHex</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/UInt.ts#L36" target="_blank">codec/UInt.ts:36</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/UInt.ts#L36" target="_blank">codec/UInt.ts:36</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2200,7 +2200,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Overrides AbstractInt.toU8a</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/UInt.ts#L48" target="_blank">codec/UInt.ts:48</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/UInt.ts#L48" target="_blank">codec/UInt.ts:48</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2266,7 +2266,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.24","depth":1,"next":{"title":"hidden","level":"4.25","depth":1,"path":"types/classes/_codec_vector_.vector.md","ref":"types/classes/_codec_vector_.vector.md","articles":[]},"previous":{"title":"hidden","level":"4.23","depth":1,"path":"types/classes/_codec_u8afixed_.u8afixed.md","ref":"types/classes/_codec_u8afixed_.u8afixed.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_uint_.uint.md","mtime":"2019-01-25T10:38:57.204Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.24","depth":1,"next":{"title":"hidden","level":"4.25","depth":1,"path":"types/classes/_codec_vector_.vector.md","ref":"types/classes/_codec_vector_.vector.md","articles":[]},"previous":{"title":"hidden","level":"4.23","depth":1,"path":"types/classes/_codec_u8afixed_.u8afixed.md","ref":"types/classes/_codec_u8afixed_.u8afixed.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_uint_.uint.md","mtime":"2019-01-26T15:31:28.453Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_codec_uint_.uint.md
+3 -3
View File
@@ -36,7 +36,7 @@
*Overrides AbstractInt.__constructor*
*Defined in [codec/UInt.ts:21](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/UInt.ts#L21)*
*Defined in [codec/UInt.ts:21](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/UInt.ts#L21)*
**Parameters:**
@@ -62,7 +62,7 @@ ___
*Overrides AbstractInt.toHex*
*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/UInt.ts#L36)*
*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/UInt.ts#L36)*
*__description__*: Returns a hex string representation of the value
@@ -79,7 +79,7 @@ ___
*Overrides AbstractInt.toU8a*
*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/UInt.ts#L48)*
*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/UInt.ts#L48)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_codec_vector_.vector.html
+15 -15
View File
@@ -2155,7 +2155,7 @@
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Vector</strong>(Type: <em><a href="../modules/_types_.md#constructor">Constructor</a>&lt;<code>T</code>&gt;</em>, value?: <em><a href="_codec_vector_.vector.html">Vector</a>&lt;<code>any</code>&gt; | <code>Uint8Array</code> | <code>string</code> | <code>Array</code>&lt;<code>any</code>&gt;</em>): <a href="_codec_vector_.vector.html">Vector</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L22" target="_blank">codec/Vector.ts:22</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L22" target="_blank">codec/Vector.ts:22</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2193,13 +2193,13 @@
<p><a id="type"></a></p>
<h2 id="type">Type</h2>
<p>getType(): <code>string</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L57" target="_blank">codec/Vector.ts:57</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L57" target="_blank">codec/Vector.ts:57</a></em></p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
<p><a id="encodedlength"></a></p>
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L64" target="_blank">codec/Vector.ts:64</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L64" target="_blank">codec/Vector.ts:64</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2207,7 +2207,7 @@
<h2 id="length">length</h2>
<p>getlength(): <code>number</code></p>
<p><em>Overrides Array.length</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L73" target="_blank">codec/Vector.ts:73</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L73" target="_blank">codec/Vector.ts:73</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2216,7 +2216,7 @@
<h2 id="eq">eq</h2>
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L81" target="_blank">codec/Vector.ts:81</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L81" target="_blank">codec/Vector.ts:81</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2239,7 +2239,7 @@
<h2 id="filter">filter</h2>
<p>&#x25B8; <strong>filter</strong>(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code>&lt;<code>T</code>&gt;</p>
<p><em>Overrides Array.filter</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L146" target="_blank">codec/Vector.ts:146</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L146" target="_blank">codec/Vector.ts:146</a></em></p>
<p><em><strong>description</strong></em>: Filters the array with the callback</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2269,7 +2269,7 @@
<h2 id="map">map</h2>
<p>&#x25B8; <strong>map</strong>&lt;<code>U</code>&gt;(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code>&lt;<code>U</code>&gt;</p>
<p><em>Overrides Array.map</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L155" target="_blank">codec/Vector.ts:155</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L155" target="_blank">codec/Vector.ts:155</a></em></p>
<p><em><strong>description</strong></em>: Maps the array with the callback</p>
<p><strong>Type parameters:</strong></p>
<h4 id="u">U</h4>
@@ -2300,7 +2300,7 @@
<p><a id="toarray"></a></p>
<h2 id="toarray">toArray</h2>
<p>&#x25B8; <strong>toArray</strong>(): <code>Array</code>&lt;<code>T</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L88" target="_blank">codec/Vector.ts:88</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L88" target="_blank">codec/Vector.ts:88</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to an standard JavaScript Array</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<code>T</code>&gt;</p>
<hr>
@@ -2308,7 +2308,7 @@
<h2 id="tohex">toHex</h2>
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L95" target="_blank">codec/Vector.ts:95</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L95" target="_blank">codec/Vector.ts:95</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2316,7 +2316,7 @@
<h2 id="tojson">toJSON</h2>
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L102" target="_blank">codec/Vector.ts:102</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L102" target="_blank">codec/Vector.ts:102</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2325,7 +2325,7 @@
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Overrides Array.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L111" target="_blank">codec/Vector.ts:111</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L111" target="_blank">codec/Vector.ts:111</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2333,7 +2333,7 @@
<h2 id="tou8a">toU8a</h2>
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L124" target="_blank">codec/Vector.ts:124</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L124" target="_blank">codec/Vector.ts:124</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2359,7 +2359,7 @@
<p><a id="decodevector"></a></p>
<h2 id="static-decodevector"><code>&lt;Static&gt;</code> decodeVector</h2>
<p>&#x25B8; <strong>decodeVector</strong>&lt;<code>T</code>&gt;(Type: <em><a href="../modules/_types_.md#constructor">Constructor</a>&lt;<code>T</code>&gt;</em>, value: <em><a href="_codec_vector_.vector.html">Vector</a>&lt;<code>any</code>&gt; | <code>Uint8Array</code> | <code>string</code> | <code>Array</code>&lt;<code>any</code>&gt;</em>): <code>Array</code>&lt;<code>T</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L32" target="_blank">codec/Vector.ts:32</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L32" target="_blank">codec/Vector.ts:32</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="t---codec">T : <a href="../interfaces/_types_.codec.md">Codec</a></h4>
<p><strong>Parameters:</strong></p>
@@ -2389,7 +2389,7 @@
<p><a id="with"></a></p>
<h2 id="static-with"><code>&lt;Static&gt;</code> with</h2>
<p>&#x25B8; <strong>with</strong>&lt;<code>O</code>&gt;(Type: <em><a href="../modules/_types_.md#constructor">Constructor</a>&lt;<code>O</code>&gt;</em>): <a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_vector_.vector.html">Vector</a>&lt;<code>O</code>&gt;&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L49" target="_blank">codec/Vector.ts:49</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L49" target="_blank">codec/Vector.ts:49</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="o---codec">O : <a href="../interfaces/_types_.codec.md">Codec</a></h4>
<p><strong>Parameters:</strong></p>
@@ -2452,7 +2452,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.25","depth":1,"next":{"title":"hidden","level":"4.26","depth":1,"path":"types/classes/_data_.data.md","ref":"types/classes/_data_.data.md","articles":[]},"previous":{"title":"hidden","level":"4.24","depth":1,"path":"types/classes/_codec_uint_.uint.md","ref":"types/classes/_codec_uint_.uint.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_vector_.vector.md","mtime":"2019-01-25T10:38:57.232Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.25","depth":1,"next":{"title":"hidden","level":"4.26","depth":1,"path":"types/classes/_data_.data.md","ref":"types/classes/_data_.data.md","articles":[]},"previous":{"title":"hidden","level":"4.24","depth":1,"path":"types/classes/_codec_uint_.uint.md","ref":"types/classes/_codec_uint_.uint.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_codec_vector_.vector.md","mtime":"2019-01-26T15:31:28.481Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_codec_vector_.vector.md
+14 -14
View File
@@ -33,7 +33,7 @@
⊕ **new Vector**(Type: *[Constructor](../modules/_types_.md#constructor)<`T`>*, value?: *[Vector](_codec_vector_.vector.md)<`any`> | `Uint8Array` | `string` | `Array`<`any`>*): [Vector](_codec_vector_.vector.md)
*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L22)*
*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L22)*
**Parameters:**
@@ -66,7 +66,7 @@ ___
getType(): `string`
*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L57)*
*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L57)*
**Returns:** `string`
@@ -77,7 +77,7 @@ ___
getencodedLength(): `number`
*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L64)*
*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L64)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -92,7 +92,7 @@ getlength(): `number`
*Overrides Array.length*
*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L73)*
*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L73)*
*__description__*: The length of the value
@@ -110,7 +110,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)*
*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L81)*
*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L81)*
*__description__*: Compares the value of the input to see if there is a match
@@ -131,7 +131,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Vector.ts:146](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L146)*
*Defined in [codec/Vector.ts:146](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L146)*
*__description__*: Filters the array with the callback
@@ -153,7 +153,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Vector.ts:155](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L155)*
*Defined in [codec/Vector.ts:155](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L155)*
*__description__*: Maps the array with the callback
@@ -176,7 +176,7 @@ ___
▸ **toArray**(): `Array`<`T`>
*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L88)*
*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L88)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -191,7 +191,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L95)*
*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L95)*
*__description__*: Returns a hex string representation of the value
@@ -206,7 +206,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/Vector.ts:102](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L102)*
*Defined in [codec/Vector.ts:102](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L102)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -223,7 +223,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Vector.ts:111](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L111)*
*Defined in [codec/Vector.ts:111](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L111)*
*__description__*: Returns the string representation of the value
@@ -238,7 +238,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)*
*Defined in [codec/Vector.ts:124](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L124)*
*Defined in [codec/Vector.ts:124](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L124)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -257,7 +257,7 @@ ___
▸ **decodeVector**<`T`>(Type: *[Constructor](../modules/_types_.md#constructor)<`T`>*, value: *[Vector](_codec_vector_.vector.md)<`any`> | `Uint8Array` | `string` | `Array`<`any`>*): `Array`<`T`>
*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L32)*
*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L32)*
**Type parameters:**
@@ -278,7 +278,7 @@ ___
▸ **with**<`O`>(Type: *[Constructor](../modules/_types_.md#constructor)<`O`>*): [Constructor](../modules/_types_.md#constructor)<[Vector](_codec_vector_.vector.md)<`O`>>
*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L49)*
*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L49)*
**Type parameters:**
docs/types/classes/_codehash_.codehash.md
+11 -11
View File
@@ -29,7 +29,7 @@
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/H256.ts#L15)*
*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/H256.ts#L15)*
**Parameters:**
@@ -51,7 +51,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -66,7 +66,7 @@ getisEmpty(): `boolean`
*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43)*
*__description__*: Returns true if the type wraps an empty/default all-0 value
@@ -83,7 +83,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50)*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50)*
*__description__*: The length of the value
@@ -101,7 +101,7 @@ ___
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8aFixed.ts#L52)*
*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8aFixed.ts#L52)*
*__description__*: Returns the number of bits in the value
@@ -118,7 +118,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L58)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L58)*
*__description__*: Compares the value of the input to see if there is a match
@@ -141,7 +141,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73)*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -165,7 +165,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80)*
*__description__*: Returns a hex string representation of the value
@@ -182,7 +182,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L87)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L87)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -201,7 +201,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L94)*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L94)*
*__description__*: Returns the string representation of the value
@@ -218,7 +218,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L102)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L102)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_data_.data.html
+11 -11
View File
@@ -2151,7 +2151,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Data</strong>(value?: <em><a href="../modules/_types_.md#anyu8a">AnyU8a</a></em>): <a href="_data_.data.html">Data</a></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L18" target="_blank">codec/U8a.ts:18</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L18" target="_blank">codec/U8a.ts:18</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2174,7 +2174,7 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2182,7 +2182,7 @@
<h2 id="isempty">isEmpty</h2>
<p>getisEmpty(): <code>boolean</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#isempty">isEmpty</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em><strong>description</strong></em>: Returns true if the type wraps an empty/default all-0 value</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
@@ -2191,7 +2191,7 @@
<p>getlength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#length">length</a></em></p>
<p><em>Overrides Uint8Array.length</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50" target="_blank">codec/U8a.ts:50</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50" target="_blank">codec/U8a.ts:50</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2201,7 +2201,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L58" target="_blank">codec/U8a.ts:58</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L58" target="_blank">codec/U8a.ts:58</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2225,7 +2225,7 @@
<p>&#x25B8; <strong>subarray</strong>(begin: <em><code>number</code></em>, end?: <em><code>undefined</code> | <code>number</code></em>): <code>Uint8Array</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#subarray">subarray</a></em></p>
<p><em>Overrides Uint8Array.subarray</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73" target="_blank">codec/U8a.ts:73</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73" target="_blank">codec/U8a.ts:73</a></em></p>
<p><em><strong>description</strong></em>: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2257,7 +2257,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80" target="_blank">codec/U8a.ts:80</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80" target="_blank">codec/U8a.ts:80</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2266,7 +2266,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L87" target="_blank">codec/U8a.ts:87</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L87" target="_blank">codec/U8a.ts:87</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2276,7 +2276,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tostring">toString</a></em></p>
<p><em>Overrides Uint8Array.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L94" target="_blank">codec/U8a.ts:94</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L94" target="_blank">codec/U8a.ts:94</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2285,7 +2285,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L102" target="_blank">codec/U8a.ts:102</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L102" target="_blank">codec/U8a.ts:102</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2351,7 +2351,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.26","depth":1,"next":{"title":"hidden","level":"4.27","depth":1,"path":"types/classes/_digest_.authoritieschange.md","ref":"types/classes/_digest_.authoritieschange.md","articles":[]},"previous":{"title":"hidden","level":"4.25","depth":1,"path":"types/classes/_codec_vector_.vector.md","ref":"types/classes/_codec_vector_.vector.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_data_.data.md","mtime":"2019-01-25T10:38:53.396Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.26","depth":1,"next":{"title":"hidden","level":"4.27","depth":1,"path":"types/classes/_digest_.authoritieschange.md","ref":"types/classes/_digest_.authoritieschange.md","articles":[]},"previous":{"title":"hidden","level":"4.25","depth":1,"path":"types/classes/_codec_vector_.vector.md","ref":"types/classes/_codec_vector_.vector.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_data_.data.md","mtime":"2019-01-26T15:31:24.373Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_data_.data.md
+10 -10
View File
@@ -27,7 +27,7 @@
*Inherited from [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)*
*Defined in [codec/U8a.ts:18](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L18)*
*Defined in [codec/U8a.ts:18](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L18)*
**Parameters:**
@@ -49,7 +49,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -64,7 +64,7 @@ getisEmpty(): `boolean`
*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43)*
*__description__*: Returns true if the type wraps an empty/default all-0 value
@@ -81,7 +81,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50)*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50)*
*__description__*: The length of the value
@@ -101,7 +101,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L58)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L58)*
*__description__*: Compares the value of the input to see if there is a match
@@ -124,7 +124,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73)*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -148,7 +148,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80)*
*__description__*: Returns a hex string representation of the value
@@ -165,7 +165,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L87)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L87)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -184,7 +184,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L94)*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L94)*
*__description__*: Returns the string representation of the value
@@ -201,7 +201,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L102)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L102)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_digest_.authoritieschange.html
+15 -15
View File
@@ -2153,7 +2153,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new AuthoritiesChange</strong>(Type: <em><a href="../modules/_types_.md#constructor">Constructor</a>&lt;<code>T</code>&gt;</em>, value?: <em><a href="_codec_vector_.vector.html">Vector</a>&lt;<code>any</code>&gt; | <code>Uint8Array</code> | <code>string</code> | <code>Array</code>&lt;<code>any</code>&gt;</em>): <a href="_digest_.authoritieschange.html">AuthoritiesChange</a></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L22" target="_blank">codec/Vector.ts:22</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L22" target="_blank">codec/Vector.ts:22</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2186,14 +2186,14 @@
<h2 id="type">Type</h2>
<p>getType(): <code>string</code></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#type">Type</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L57" target="_blank">codec/Vector.ts:57</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L57" target="_blank">codec/Vector.ts:57</a></em></p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
<p><a id="encodedlength"></a></p>
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L64" target="_blank">codec/Vector.ts:64</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L64" target="_blank">codec/Vector.ts:64</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2202,7 +2202,7 @@
<p>getlength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#length">length</a></em></p>
<p><em>Overrides Array.length</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L73" target="_blank">codec/Vector.ts:73</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L73" target="_blank">codec/Vector.ts:73</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2212,7 +2212,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L81" target="_blank">codec/Vector.ts:81</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L81" target="_blank">codec/Vector.ts:81</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2236,7 +2236,7 @@
<p>&#x25B8; <strong>filter</strong>(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code>&lt;<code>T</code>&gt;</p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#filter">filter</a></em></p>
<p><em>Overrides Array.filter</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L146" target="_blank">codec/Vector.ts:146</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L146" target="_blank">codec/Vector.ts:146</a></em></p>
<p><em><strong>description</strong></em>: Filters the array with the callback</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2267,7 +2267,7 @@
<p>&#x25B8; <strong>map</strong>&lt;<code>U</code>&gt;(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code>&lt;<code>U</code>&gt;</p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#map">map</a></em></p>
<p><em>Overrides Array.map</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L155" target="_blank">codec/Vector.ts:155</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L155" target="_blank">codec/Vector.ts:155</a></em></p>
<p><em><strong>description</strong></em>: Maps the array with the callback</p>
<p><strong>Type parameters:</strong></p>
<h4 id="u">U</h4>
@@ -2299,7 +2299,7 @@
<h2 id="toarray">toArray</h2>
<p>&#x25B8; <strong>toArray</strong>(): <code>Array</code>&lt;<code>T</code>&gt;</p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#toarray">toArray</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L88" target="_blank">codec/Vector.ts:88</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L88" target="_blank">codec/Vector.ts:88</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to an standard JavaScript Array</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<code>T</code>&gt;</p>
<hr>
@@ -2308,7 +2308,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L95" target="_blank">codec/Vector.ts:95</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L95" target="_blank">codec/Vector.ts:95</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2317,7 +2317,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L102" target="_blank">codec/Vector.ts:102</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L102" target="_blank">codec/Vector.ts:102</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2327,7 +2327,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#tostring">toString</a></em></p>
<p><em>Overrides Array.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L111" target="_blank">codec/Vector.ts:111</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L111" target="_blank">codec/Vector.ts:111</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2336,7 +2336,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L124" target="_blank">codec/Vector.ts:124</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L124" target="_blank">codec/Vector.ts:124</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2363,7 +2363,7 @@
<h2 id="static-decodevector"><code>&lt;Static&gt;</code> decodeVector</h2>
<p>&#x25B8; <strong>decodeVector</strong>&lt;<code>T</code>&gt;(Type: <em><a href="../modules/_types_.md#constructor">Constructor</a>&lt;<code>T</code>&gt;</em>, value: <em><a href="_codec_vector_.vector.html">Vector</a>&lt;<code>any</code>&gt; | <code>Uint8Array</code> | <code>string</code> | <code>Array</code>&lt;<code>any</code>&gt;</em>): <code>Array</code>&lt;<code>T</code>&gt;</p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#decodevector">decodeVector</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L32" target="_blank">codec/Vector.ts:32</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L32" target="_blank">codec/Vector.ts:32</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="t---codec">T : <a href="../interfaces/_types_.codec.md">Codec</a></h4>
<p><strong>Parameters:</strong></p>
@@ -2394,7 +2394,7 @@
<h2 id="static-with"><code>&lt;Static&gt;</code> with</h2>
<p>&#x25B8; <strong>with</strong>&lt;<code>O</code>&gt;(Type: <em><a href="../modules/_types_.md#constructor">Constructor</a>&lt;<code>O</code>&gt;</em>): <a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_vector_.vector.html">Vector</a>&lt;<code>O</code>&gt;&gt;</p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#with">with</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L49" target="_blank">codec/Vector.ts:49</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L49" target="_blank">codec/Vector.ts:49</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="o---codec">O : <a href="../interfaces/_types_.codec.md">Codec</a></h4>
<p><strong>Parameters:</strong></p>
@@ -2457,7 +2457,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.27","depth":1,"next":{"title":"hidden","level":"4.28","depth":1,"path":"types/classes/_digest_.changestrieroot.md","ref":"types/classes/_digest_.changestrieroot.md","articles":[]},"previous":{"title":"hidden","level":"4.26","depth":1,"path":"types/classes/_data_.data.md","ref":"types/classes/_data_.data.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_digest_.authoritieschange.md","mtime":"2019-01-25T10:38:53.436Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.27","depth":1,"next":{"title":"hidden","level":"4.28","depth":1,"path":"types/classes/_digest_.changestrieroot.md","ref":"types/classes/_digest_.changestrieroot.md","articles":[]},"previous":{"title":"hidden","level":"4.26","depth":1,"path":"types/classes/_data_.data.md","ref":"types/classes/_data_.data.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_digest_.authoritieschange.md","mtime":"2019-01-26T15:31:24.409Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_digest_.authoritieschange.md
+14 -14
View File
@@ -29,7 +29,7 @@
*Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)*
*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L22)*
*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L22)*
**Parameters:**
@@ -52,7 +52,7 @@ getType(): `string`
*Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)*
*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L57)*
*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L57)*
**Returns:** `string`
@@ -65,7 +65,7 @@ getencodedLength(): `number`
*Inherited from [Vector](_codec_vector_.vector.md).[encodedLength](_codec_vector_.vector.md#encodedlength)*
*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L64)*
*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L64)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -82,7 +82,7 @@ getlength(): `number`
*Overrides Array.length*
*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L73)*
*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L73)*
*__description__*: The length of the value
@@ -102,7 +102,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[eq](_codec_vector_.vector.md#eq)*
*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L81)*
*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L81)*
*__description__*: Compares the value of the input to see if there is a match
@@ -125,7 +125,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Vector.ts:146](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L146)*
*Defined in [codec/Vector.ts:146](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L146)*
*__description__*: Filters the array with the callback
@@ -149,7 +149,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Vector.ts:155](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L155)*
*Defined in [codec/Vector.ts:155](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L155)*
*__description__*: Maps the array with the callback
@@ -174,7 +174,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)*
*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L88)*
*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L88)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -191,7 +191,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)*
*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L95)*
*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L95)*
*__description__*: Returns a hex string representation of the value
@@ -208,7 +208,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)*
*Defined in [codec/Vector.ts:102](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L102)*
*Defined in [codec/Vector.ts:102](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L102)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -227,7 +227,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Vector.ts:111](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L111)*
*Defined in [codec/Vector.ts:111](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L111)*
*__description__*: Returns the string representation of the value
@@ -244,7 +244,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)*
*Defined in [codec/Vector.ts:124](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L124)*
*Defined in [codec/Vector.ts:124](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L124)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -265,7 +265,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[decodeVector](_codec_vector_.vector.md#decodevector)*
*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L32)*
*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L32)*
**Type parameters:**
@@ -288,7 +288,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)*
*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L49)*
*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L49)*
**Type parameters:**
docs/types/classes/_digest_.changestrieroot.html
+12 -12
View File
@@ -2152,7 +2152,7 @@
<p>&#x2295; <strong>new ChangesTrieRoot</strong>(value?: <em><a href="../modules/_types_.md#anyu8a">AnyU8a</a></em>): <a href="_digest_.changestrieroot.html">ChangesTrieRoot</a></p>
<p><em>Inherited from <a href="_h256_.h256.html">H256</a>.<a href="_h256_.h256.html#constructor">constructor</a></em></p>
<p><em>Overrides <a href="_codec_u8afixed_.u8afixed.html">U8aFixed</a>.<a href="_codec_u8afixed_.u8afixed.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/H256.ts#L15" target="_blank">H256.ts:15</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/H256.ts#L15" target="_blank">H256.ts:15</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2175,7 +2175,7 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2183,7 +2183,7 @@
<h2 id="isempty">isEmpty</h2>
<p>getisEmpty(): <code>boolean</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#isempty">isEmpty</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em><strong>description</strong></em>: Returns true if the type wraps an empty/default all-0 value</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
@@ -2192,7 +2192,7 @@
<p>getlength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#length">length</a></em></p>
<p><em>Overrides Uint8Array.length</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50" target="_blank">codec/U8a.ts:50</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50" target="_blank">codec/U8a.ts:50</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2201,7 +2201,7 @@
<h2 id="bitlength">bitLength</h2>
<p>&#x25B8; <strong>bitLength</strong>(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8afixed_.u8afixed.html">U8aFixed</a>.<a href="_codec_u8afixed_.u8afixed.html#bitlength">bitLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8aFixed.ts#L52" target="_blank">codec/U8aFixed.ts:52</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8aFixed.ts#L52" target="_blank">codec/U8aFixed.ts:52</a></em></p>
<p><em><strong>description</strong></em>: Returns the number of bits in the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2210,7 +2210,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L58" target="_blank">codec/U8a.ts:58</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L58" target="_blank">codec/U8a.ts:58</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2234,7 +2234,7 @@
<p>&#x25B8; <strong>subarray</strong>(begin: <em><code>number</code></em>, end?: <em><code>undefined</code> | <code>number</code></em>): <code>Uint8Array</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#subarray">subarray</a></em></p>
<p><em>Overrides Uint8Array.subarray</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73" target="_blank">codec/U8a.ts:73</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73" target="_blank">codec/U8a.ts:73</a></em></p>
<p><em><strong>description</strong></em>: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2266,7 +2266,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80" target="_blank">codec/U8a.ts:80</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80" target="_blank">codec/U8a.ts:80</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2275,7 +2275,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L87" target="_blank">codec/U8a.ts:87</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L87" target="_blank">codec/U8a.ts:87</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2285,7 +2285,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tostring">toString</a></em></p>
<p><em>Overrides Uint8Array.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L94" target="_blank">codec/U8a.ts:94</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L94" target="_blank">codec/U8a.ts:94</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2294,7 +2294,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L102" target="_blank">codec/U8a.ts:102</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L102" target="_blank">codec/U8a.ts:102</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2360,7 +2360,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.28","depth":1,"next":{"title":"hidden","level":"4.29","depth":1,"path":"types/classes/_digest_.digest.md","ref":"types/classes/_digest_.digest.md","articles":[]},"previous":{"title":"hidden","level":"4.27","depth":1,"path":"types/classes/_digest_.authoritieschange.md","ref":"types/classes/_digest_.authoritieschange.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_digest_.changestrieroot.md","mtime":"2019-01-25T10:38:53.468Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.28","depth":1,"next":{"title":"hidden","level":"4.29","depth":1,"path":"types/classes/_digest_.digest.md","ref":"types/classes/_digest_.digest.md","articles":[]},"previous":{"title":"hidden","level":"4.27","depth":1,"path":"types/classes/_digest_.authoritieschange.md","ref":"types/classes/_digest_.authoritieschange.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_digest_.changestrieroot.md","mtime":"2019-01-26T15:31:24.449Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_digest_.changestrieroot.md
+11 -11
View File
@@ -29,7 +29,7 @@
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/H256.ts#L15)*
*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/H256.ts#L15)*
**Parameters:**
@@ -51,7 +51,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -66,7 +66,7 @@ getisEmpty(): `boolean`
*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43)*
*__description__*: Returns true if the type wraps an empty/default all-0 value
@@ -83,7 +83,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50)*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50)*
*__description__*: The length of the value
@@ -101,7 +101,7 @@ ___
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8aFixed.ts#L52)*
*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8aFixed.ts#L52)*
*__description__*: Returns the number of bits in the value
@@ -118,7 +118,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L58)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L58)*
*__description__*: Compares the value of the input to see if there is a match
@@ -141,7 +141,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73)*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -165,7 +165,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80)*
*__description__*: Returns a hex string representation of the value
@@ -182,7 +182,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L87)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L87)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -201,7 +201,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L94)*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L94)*
*__description__*: Returns the string representation of the value
@@ -218,7 +218,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L102)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L102)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_digest_.digest.html
+14 -14
View File
@@ -2154,7 +2154,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Digest</strong>(value: <em><code>any</code></em>): <a href="_digest_.digest.html">Digest</a></p>
<p><em>Overrides <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Digest.ts#L117" target="_blank">Digest.ts:117</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Digest.ts#L117" target="_blank">Digest.ts:117</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2177,7 +2177,7 @@
<h2 id="type">Type</h2>
<p>getType(): <code>E</code></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#type">Type</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L142" target="_blank">codec/Struct.ts:142</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L142" target="_blank">codec/Struct.ts:142</a></em></p>
<p><em><strong>description</strong></em>: Returns the Type description to sthe structure</p>
<p><strong>Returns:</strong> <code>E</code></p>
<hr>
@@ -2185,14 +2185,14 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L149" target="_blank">codec/Struct.ts:149</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L149" target="_blank">codec/Struct.ts:149</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="logs"></a></p>
<h2 id="logs">logs</h2>
<p>getlogs(): <a href="_codec_vector_.vector.html">Vector</a>&lt;<a href="_digest_.digestitem.html">DigestItem</a>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Digest.ts#L127" target="_blank">Digest.ts:127</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Digest.ts#L127" target="_blank">Digest.ts:127</a></em></p>
<p><em><strong>description</strong></em>: The <a href="_digest_.digestitem.html">DigestItem</a> logs</p>
<p><strong>Returns:</strong> <a href="_codec_vector_.vector.html">Vector</a>&lt;<a href="_digest_.digestitem.html">DigestItem</a>&gt;</p>
<hr>
@@ -2202,7 +2202,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L158" target="_blank">codec/Struct.ts:158</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L158" target="_blank">codec/Struct.ts:158</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2226,7 +2226,7 @@
<p>&#x25B8; <strong>get</strong>(name: <em><code>keyof S</code></em>): <a href="../interfaces/_types_.codec.md">Codec</a> | <code>undefined</code></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#get">get</a></em></p>
<p><em>Overrides Map.get</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L166" target="_blank">codec/Struct.ts:166</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L166" target="_blank">codec/Struct.ts:166</a></em></p>
<p><em><strong>description</strong></em>: Returns a specific names entry in the structure</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2251,7 +2251,7 @@
<h2 id="getatindex">getAtIndex</h2>
<p>&#x25B8; <strong>getAtIndex</strong>(index: <em><code>number</code></em>): <a href="../interfaces/_types_.codec.md">Codec</a></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#getatindex">getAtIndex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L173" target="_blank">codec/Struct.ts:173</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L173" target="_blank">codec/Struct.ts:173</a></em></p>
<p><em><strong>description</strong></em>: Returns the values of a member at a specific index (Rather use get(name) for performance)</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2274,7 +2274,7 @@
<h2 id="toarray">toArray</h2>
<p>&#x25B8; <strong>toArray</strong>(): <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#toarray">toArray</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L180" target="_blank">codec/Struct.ts:180</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L180" target="_blank">codec/Struct.ts:180</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to an standard JavaScript Array</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<hr>
@@ -2283,7 +2283,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L187" target="_blank">codec/Struct.ts:187</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L187" target="_blank">codec/Struct.ts:187</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2292,7 +2292,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L194" target="_blank">codec/Struct.ts:194</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L194" target="_blank">codec/Struct.ts:194</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2301,7 +2301,7 @@
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L208" target="_blank">codec/Struct.ts:208</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L208" target="_blank">codec/Struct.ts:208</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2310,7 +2310,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L216" target="_blank">codec/Struct.ts:216</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L216" target="_blank">codec/Struct.ts:216</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2337,7 +2337,7 @@
<h2 id="static-with"><code>&lt;Static&gt;</code> with</h2>
<p>&#x25B8; <strong>with</strong>&lt;<code>S</code>&gt;(Types: <em><code>S</code></em>): <a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_struct_.struct.html">Struct</a>&lt;<code>S</code>&gt;&gt;</p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#with">with</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L122" target="_blank">codec/Struct.ts:122</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L122" target="_blank">codec/Struct.ts:122</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="s---constructordef">S : <a href="../modules/_types_.md#constructordef">ConstructorDef</a></h4>
<p><strong>Parameters:</strong></p>
@@ -2400,7 +2400,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.29","depth":1,"next":{"title":"hidden","level":"4.30","depth":1,"path":"types/classes/_digest_.digestitem.md","ref":"types/classes/_digest_.digestitem.md","articles":[]},"previous":{"title":"hidden","level":"4.28","depth":1,"path":"types/classes/_digest_.changestrieroot.md","ref":"types/classes/_digest_.changestrieroot.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_digest_.digest.md","mtime":"2019-01-25T10:38:53.500Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.29","depth":1,"next":{"title":"hidden","level":"4.30","depth":1,"path":"types/classes/_digest_.digestitem.md","ref":"types/classes/_digest_.digestitem.md","articles":[]},"previous":{"title":"hidden","level":"4.28","depth":1,"path":"types/classes/_digest_.changestrieroot.md","ref":"types/classes/_digest_.changestrieroot.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_digest_.digest.md","mtime":"2019-01-26T15:31:24.481Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_digest_.digest.md
+13 -13
View File
@@ -29,7 +29,7 @@
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Digest.ts:117](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Digest.ts#L117)*
*Defined in [Digest.ts:117](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Digest.ts#L117)*
**Parameters:**
@@ -51,7 +51,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L142)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L142)*
*__description__*: Returns the Type description to sthe structure
@@ -66,7 +66,7 @@ getencodedLength(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L149)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L149)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -79,7 +79,7 @@ ___
getlogs(): [Vector](_codec_vector_.vector.md)<[DigestItem](_digest_.digestitem.md)>
*Defined in [Digest.ts:127](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Digest.ts#L127)*
*Defined in [Digest.ts:127](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Digest.ts#L127)*
*__description__*: The [DigestItem](_digest_.digestitem.md) logs
@@ -99,7 +99,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L158)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L158)*
*__description__*: Compares the value of the input to see if there is a match
@@ -122,7 +122,7 @@ ___
*Overrides Map.get*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L166)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Returns a specific names entry in the structure
@@ -143,7 +143,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L173)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L173)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -164,7 +164,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L180)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -181,7 +181,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L187)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L187)*
*__description__*: Returns a hex string representation of the value
@@ -198,7 +198,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L194)*
*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L194)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -215,7 +215,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L208)*
*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L208)*
*__description__*: Returns the string representation of the value
@@ -232,7 +232,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L216)*
*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L216)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -253,7 +253,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L122)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L122)*
**Type parameters:**
docs/types/classes/_digest_.digestitem.html
+25 -17
View File
@@ -2149,7 +2149,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new DigestItem</strong>(value: <em><code>any</code></em>): <a href="_digest_.digestitem.html">DigestItem</a></p>
<p><em>Overrides <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Digest.ts#L73" target="_blank">Digest.ts:73</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Digest.ts#L73" target="_blank">Digest.ts:73</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2171,28 +2171,28 @@
<p><a id="asauthoritieschange"></a></p>
<h2 id="asauthoritieschange">asAuthoritiesChange</h2>
<p>getasAuthoritiesChange(): <a href="_digest_.authoritieschange.html">AuthoritiesChange</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Digest.ts#L86" target="_blank">Digest.ts:86</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Digest.ts#L86" target="_blank">Digest.ts:86</a></em></p>
<p><em><strong>description</strong></em>: Returns the item as a <a href="_digest_.authoritieschange.html">AuthoritiesChange</a></p>
<p><strong>Returns:</strong> <a href="_digest_.authoritieschange.html">AuthoritiesChange</a></p>
<hr>
<p><a id="aschangestrieroot"></a></p>
<h2 id="aschangestrieroot">asChangesTrieRoot</h2>
<p>getasChangesTrieRoot(): <a href="_digest_.changestrieroot.html">ChangesTrieRoot</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Digest.ts#L93" target="_blank">Digest.ts:93</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Digest.ts#L93" target="_blank">Digest.ts:93</a></em></p>
<p><em><strong>description</strong></em>: Returns the item as a <a href="_digest_.changestrieroot.html">ChangesTrieRoot</a></p>
<p><strong>Returns:</strong> <a href="_digest_.changestrieroot.html">ChangesTrieRoot</a></p>
<hr>
<p><a id="asother"></a></p>
<h2 id="asother">asOther</h2>
<p>getasOther(): <a href="_digest_.other.html">Other</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Digest.ts#L100" target="_blank">Digest.ts:100</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Digest.ts#L100" target="_blank">Digest.ts:100</a></em></p>
<p><em><strong>description</strong></em>: Returns the item as a <a href="_digest_.other.html">Other</a></p>
<p><strong>Returns:</strong> <a href="_digest_.other.html">Other</a></p>
<hr>
<p><a id="asseal"></a></p>
<h2 id="asseal">asSeal</h2>
<p>getasSeal(): <a href="_digest_.seal.html">Seal</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Digest.ts#L107" target="_blank">Digest.ts:107</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Digest.ts#L107" target="_blank">Digest.ts:107</a></em></p>
<p><em><strong>description</strong></em>: Returns the item as a <a href="_digest_.seal.html">Seal</a></p>
<p><strong>Returns:</strong> <a href="_digest_.seal.html">Seal</a></p>
<hr>
@@ -2200,15 +2200,23 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L101" target="_blank">codec/EnumType.ts:101</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L101" target="_blank">codec/EnumType.ts:101</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="index"></a></p>
<h2 id="index">index</h2>
<p>getindex(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#index">index</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L108" target="_blank">codec/EnumType.ts:108</a></em></p>
<p><em><strong>description</strong></em>: The index of the metadata value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="isnone"></a></p>
<h2 id="isnone">isNone</h2>
<p>getisNone(): <code>boolean</code></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#isnone">isNone</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L108" target="_blank">codec/EnumType.ts:108</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L115" target="_blank">codec/EnumType.ts:115</a></em></p>
<p><em><strong>description</strong></em>: Checks if the Enum points to a <a href="_null_.null.html">Null</a> type</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
@@ -2216,7 +2224,7 @@
<h2 id="isnull">isNull</h2>
<p>getisNull(): <code>boolean</code></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#isnull">isNull</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L115" target="_blank">codec/EnumType.ts:115</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L122" target="_blank">codec/EnumType.ts:122</a></em></p>
<p><em><strong>description</strong></em>: Checks if the Enum points to a <a href="_null_.null.html">Null</a> type (deprecated, use isNone)</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
@@ -2224,7 +2232,7 @@
<h2 id="type">type</h2>
<p>gettype(): <code>string</code></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#type">type</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L122" target="_blank">codec/EnumType.ts:122</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L129" target="_blank">codec/EnumType.ts:129</a></em></p>
<p><em><strong>description</strong></em>: The name of the type this enum value represents</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2232,7 +2240,7 @@
<h2 id="value">value</h2>
<p>getvalue(): <a href="../interfaces/_types_.codec.md">Codec</a></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#value">value</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L129" target="_blank">codec/EnumType.ts:129</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L136" target="_blank">codec/EnumType.ts:136</a></em></p>
<p><em><strong>description</strong></em>: The value of the enum</p>
<p><strong>Returns:</strong> <a href="../interfaces/_types_.codec.md">Codec</a></p>
<hr>
@@ -2242,7 +2250,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L136" target="_blank">codec/EnumType.ts:136</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L143" target="_blank">codec/EnumType.ts:143</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2266,7 +2274,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L149" target="_blank">codec/EnumType.ts:149</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L156" target="_blank">codec/EnumType.ts:156</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2275,7 +2283,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L156" target="_blank">codec/EnumType.ts:156</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L163" target="_blank">codec/EnumType.ts:163</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2283,7 +2291,7 @@
<h2 id="tonumber">toNumber</h2>
<p>&#x25B8; <strong>toNumber</strong>(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#tonumber">toNumber</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L163" target="_blank">codec/EnumType.ts:163</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L170" target="_blank">codec/EnumType.ts:170</a></em></p>
<p><em><strong>description</strong></em>: Returns the number representation for the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2292,7 +2300,7 @@
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L170" target="_blank">codec/EnumType.ts:170</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L177" target="_blank">codec/EnumType.ts:177</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2301,7 +2309,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L178" target="_blank">codec/EnumType.ts:178</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L185" target="_blank">codec/EnumType.ts:185</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2367,7 +2375,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.30","depth":1,"next":{"title":"hidden","level":"4.31","depth":1,"path":"types/classes/_digest_.other.md","ref":"types/classes/_digest_.other.md","articles":[]},"previous":{"title":"hidden","level":"4.29","depth":1,"path":"types/classes/_digest_.digest.md","ref":"types/classes/_digest_.digest.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_digest_.digestitem.md","mtime":"2019-01-25T10:38:53.556Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.30","depth":1,"next":{"title":"hidden","level":"4.31","depth":1,"path":"types/classes/_digest_.other.md","ref":"types/classes/_digest_.other.md","articles":[]},"previous":{"title":"hidden","level":"4.29","depth":1,"path":"types/classes/_digest_.digest.md","ref":"types/classes/_digest_.digest.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_digest_.digestitem.md","mtime":"2019-01-26T15:31:24.525Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_digest_.digestitem.md
+31 -16
View File
@@ -24,7 +24,7 @@
*Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)*
*Defined in [Digest.ts:73](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Digest.ts#L73)*
*Defined in [Digest.ts:73](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Digest.ts#L73)*
**Parameters:**
@@ -44,7 +44,7 @@ ___
getasAuthoritiesChange(): [AuthoritiesChange](_digest_.authoritieschange.md)
*Defined in [Digest.ts:86](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Digest.ts#L86)*
*Defined in [Digest.ts:86](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Digest.ts#L86)*
*__description__*: Returns the item as a [AuthoritiesChange](_digest_.authoritieschange.md)
@@ -57,7 +57,7 @@ ___
getasChangesTrieRoot(): [ChangesTrieRoot](_digest_.changestrieroot.md)
*Defined in [Digest.ts:93](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Digest.ts#L93)*
*Defined in [Digest.ts:93](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Digest.ts#L93)*
*__description__*: Returns the item as a [ChangesTrieRoot](_digest_.changestrieroot.md)
@@ -70,7 +70,7 @@ ___
getasOther(): [Other](_digest_.other.md)
*Defined in [Digest.ts:100](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Digest.ts#L100)*
*Defined in [Digest.ts:100](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Digest.ts#L100)*
*__description__*: Returns the item as a [Other](_digest_.other.md)
@@ -83,7 +83,7 @@ ___
getasSeal(): [Seal](_digest_.seal.md)
*Defined in [Digest.ts:107](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Digest.ts#L107)*
*Defined in [Digest.ts:107](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Digest.ts#L107)*
*__description__*: Returns the item as a [Seal](_digest_.seal.md)
@@ -98,12 +98,27 @@ getencodedLength(): `number`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)*
*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L101)*
*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L101)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
___
<a id="index"></a>
## index
getindex(): `number`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)*
*Defined in [codec/EnumType.ts:108](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L108)*
*__description__*: The index of the metadata value
**Returns:** `number`
___
<a id="isnone"></a>
@@ -113,7 +128,7 @@ getisNone(): `boolean`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)*
*Defined in [codec/EnumType.ts:108](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L108)*
*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L115)*
*__description__*: Checks if the Enum points to a [Null](_null_.null.md) type
@@ -128,7 +143,7 @@ getisNull(): `boolean`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)*
*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L115)*
*Defined in [codec/EnumType.ts:122](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L122)*
*__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone)
@@ -143,7 +158,7 @@ gettype(): `string`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)*
*Defined in [codec/EnumType.ts:122](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L122)*
*Defined in [codec/EnumType.ts:129](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L129)*
*__description__*: The name of the type this enum value represents
@@ -158,7 +173,7 @@ getvalue(): [Codec](../interfaces/_types_.codec.md)
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)*
*Defined in [codec/EnumType.ts:129](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L129)*
*Defined in [codec/EnumType.ts:136](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L136)*
*__description__*: The value of the enum
@@ -178,7 +193,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)*
*Defined in [codec/EnumType.ts:136](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L136)*
*Defined in [codec/EnumType.ts:143](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L143)*
*__description__*: Compares the value of the input to see if there is a match
@@ -201,7 +216,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)*
*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L149)*
*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L156)*
*__description__*: Returns a hex string representation of the value
@@ -218,7 +233,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)*
*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L156)*
*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L163)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -233,7 +248,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)*
*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L163)*
*Defined in [codec/EnumType.ts:170](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L170)*
*__description__*: Returns the number representation for the value
@@ -250,7 +265,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)*
*Defined in [codec/EnumType.ts:170](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L170)*
*Defined in [codec/EnumType.ts:177](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L177)*
*__description__*: Returns the string representation of the value
@@ -267,7 +282,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)*
*Defined in [codec/EnumType.ts:178](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L178)*
*Defined in [codec/EnumType.ts:185](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L185)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_digest_.other.html
+11 -11
View File
@@ -2152,7 +2152,7 @@
<p>&#x2295; <strong>new Other</strong>(value?: <em><a href="../modules/_types_.md#anyu8a">AnyU8a</a></em>): <a href="_digest_.other.html">Other</a></p>
<p><em>Inherited from <a href="_bytes_.bytes.html">Bytes</a>.<a href="_bytes_.bytes.html#constructor">constructor</a></em></p>
<p><em>Overrides <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bytes.ts#L18" target="_blank">Bytes.ts:18</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bytes.ts#L18" target="_blank">Bytes.ts:18</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2176,7 +2176,7 @@
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_bytes_.bytes.html">Bytes</a>.<a href="_bytes_.bytes.html#encodedlength">encodedLength</a></em></p>
<p><em>Overrides <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bytes.ts#L61" target="_blank">Bytes.ts:61</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bytes.ts#L61" target="_blank">Bytes.ts:61</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2184,7 +2184,7 @@
<h2 id="isempty">isEmpty</h2>
<p>getisEmpty(): <code>boolean</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#isempty">isEmpty</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em><strong>description</strong></em>: Returns true if the type wraps an empty/default all-0 value</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
@@ -2193,7 +2193,7 @@
<p>getlength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#length">length</a></em></p>
<p><em>Overrides Uint8Array.length</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50" target="_blank">codec/U8a.ts:50</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50" target="_blank">codec/U8a.ts:50</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2203,7 +2203,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L58" target="_blank">codec/U8a.ts:58</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L58" target="_blank">codec/U8a.ts:58</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2227,7 +2227,7 @@
<p>&#x25B8; <strong>subarray</strong>(begin: <em><code>number</code></em>, end?: <em><code>undefined</code> | <code>number</code></em>): <code>Uint8Array</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#subarray">subarray</a></em></p>
<p><em>Overrides Uint8Array.subarray</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73" target="_blank">codec/U8a.ts:73</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73" target="_blank">codec/U8a.ts:73</a></em></p>
<p><em><strong>description</strong></em>: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2259,7 +2259,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80" target="_blank">codec/U8a.ts:80</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80" target="_blank">codec/U8a.ts:80</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2268,7 +2268,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L87" target="_blank">codec/U8a.ts:87</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L87" target="_blank">codec/U8a.ts:87</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2278,7 +2278,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tostring">toString</a></em></p>
<p><em>Overrides Uint8Array.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L94" target="_blank">codec/U8a.ts:94</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L94" target="_blank">codec/U8a.ts:94</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2288,7 +2288,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_bytes_.bytes.html">Bytes</a>.<a href="_bytes_.bytes.html#tou8a">toU8a</a></em></p>
<p><em>Overrides <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bytes.ts#L69" target="_blank">Bytes.ts:69</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bytes.ts#L69" target="_blank">Bytes.ts:69</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2354,7 +2354,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.31","depth":1,"next":{"title":"hidden","level":"4.32","depth":1,"path":"types/classes/_digest_.seal.md","ref":"types/classes/_digest_.seal.md","articles":[]},"previous":{"title":"hidden","level":"4.30","depth":1,"path":"types/classes/_digest_.digestitem.md","ref":"types/classes/_digest_.digestitem.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_digest_.other.md","mtime":"2019-01-25T10:38:53.584Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.31","depth":1,"next":{"title":"hidden","level":"4.32","depth":1,"path":"types/classes/_digest_.seal.md","ref":"types/classes/_digest_.seal.md","articles":[]},"previous":{"title":"hidden","level":"4.30","depth":1,"path":"types/classes/_digest_.digestitem.md","ref":"types/classes/_digest_.digestitem.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_digest_.other.md","mtime":"2019-01-26T15:31:24.561Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_digest_.other.md
+10 -10
View File
@@ -29,7 +29,7 @@
*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)*
*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bytes.ts#L18)*
*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bytes.ts#L18)*
**Parameters:**
@@ -53,7 +53,7 @@ getencodedLength(): `number`
*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bytes.ts#L61)*
*Defined in [Bytes.ts:61](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bytes.ts#L61)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -68,7 +68,7 @@ getisEmpty(): `boolean`
*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43)*
*__description__*: Returns true if the type wraps an empty/default all-0 value
@@ -85,7 +85,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50)*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50)*
*__description__*: The length of the value
@@ -105,7 +105,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L58)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L58)*
*__description__*: Compares the value of the input to see if there is a match
@@ -128,7 +128,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73)*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -152,7 +152,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80)*
*__description__*: Returns a hex string representation of the value
@@ -169,7 +169,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L87)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L87)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -188,7 +188,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L94)*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L94)*
*__description__*: Returns the string representation of the value
@@ -207,7 +207,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [Bytes.ts:69](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Bytes.ts#L69)*
*Defined in [Bytes.ts:69](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Bytes.ts#L69)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_digest_.seal.html
+15 -15
View File
@@ -2151,7 +2151,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Seal</strong>(value: <em><code>any</code></em>): <a href="_digest_.seal.html">Seal</a></p>
<p><em>Overrides <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Digest.ts#L44" target="_blank">Digest.ts:44</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Digest.ts#L44" target="_blank">Digest.ts:44</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2174,7 +2174,7 @@
<h2 id="types">Types</h2>
<p>getTypes(): <code>Array</code>&lt;<code>string</code>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#types">Types</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L68" target="_blank">codec/Tuple.ts:68</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L68" target="_blank">codec/Tuple.ts:68</a></em></p>
<p><em><strong>description</strong></em>: The types definition of the tuple</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<code>string</code>&gt;</p>
<hr>
@@ -2182,21 +2182,21 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L59" target="_blank">codec/Tuple.ts:59</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L59" target="_blank">codec/Tuple.ts:59</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="signature"></a></p>
<h2 id="signature">signature</h2>
<p>getsignature(): <a href="_signature_.signature.html">Signature</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Digest.ts#L55" target="_blank">Digest.ts:55</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Digest.ts#L55" target="_blank">Digest.ts:55</a></em></p>
<p><em><strong>description</strong></em>: The wrapped <a href="_signature_.signature.html">Signature</a></p>
<p><strong>Returns:</strong> <a href="_signature_.signature.html">Signature</a></p>
<hr>
<p><a id="slot"></a></p>
<h2 id="slot">slot</h2>
<p>getslot(): <a href="_u64_.u64.html">U64</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Digest.ts#L62" target="_blank">Digest.ts:62</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Digest.ts#L62" target="_blank">Digest.ts:62</a></em></p>
<p><em><strong>description</strong></em>: The wrapped <a href="_u64_.u64.html">U64</a> slot</p>
<p><strong>Returns:</strong> <a href="_u64_.u64.html">U64</a></p>
<hr>
@@ -2206,7 +2206,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L77" target="_blank">codec/Tuple.ts:77</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L77" target="_blank">codec/Tuple.ts:77</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2230,7 +2230,7 @@
<p>&#x25B8; <strong>filter</strong>(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#filter">filter</a></em></p>
<p><em>Overrides Array.filter</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L133" target="_blank">codec/Tuple.ts:133</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L133" target="_blank">codec/Tuple.ts:133</a></em></p>
<p><em><strong>description</strong></em>: Filters the array with the callback</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2261,7 +2261,7 @@
<p>&#x25B8; <strong>map</strong>&lt;<code>U</code>&gt;(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code>&lt;<code>U</code>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#map">map</a></em></p>
<p><em>Overrides Array.map</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L142" target="_blank">codec/Tuple.ts:142</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L142" target="_blank">codec/Tuple.ts:142</a></em></p>
<p><em><strong>description</strong></em>: Maps the array with the callback</p>
<p><strong>Type parameters:</strong></p>
<h4 id="u">U</h4>
@@ -2293,7 +2293,7 @@
<h2 id="toarray">toArray</h2>
<p>&#x25B8; <strong>toArray</strong>(): <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#toarray">toArray</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L84" target="_blank">codec/Tuple.ts:84</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L84" target="_blank">codec/Tuple.ts:84</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to an standard JavaScript Array</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<hr>
@@ -2302,7 +2302,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L91" target="_blank">codec/Tuple.ts:91</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L91" target="_blank">codec/Tuple.ts:91</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2311,7 +2311,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L98" target="_blank">codec/Tuple.ts:98</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L98" target="_blank">codec/Tuple.ts:98</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2321,7 +2321,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tostring">toString</a></em></p>
<p><em>Overrides Array.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L107" target="_blank">codec/Tuple.ts:107</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L107" target="_blank">codec/Tuple.ts:107</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2330,7 +2330,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L116" target="_blank">codec/Tuple.ts:116</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L116" target="_blank">codec/Tuple.ts:116</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2357,7 +2357,7 @@
<h2 id="static-with"><code>&lt;Static&gt;</code> with</h2>
<p>&#x25B8; <strong>with</strong>(Types: <em><code>TupleConstructors</code></em>): <a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_tuple_.tuple.html">Tuple</a>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#with">with</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L48" target="_blank">codec/Tuple.ts:48</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L48" target="_blank">codec/Tuple.ts:48</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2418,7 +2418,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.32","depth":1,"next":{"title":"hidden","level":"4.33","depth":1,"path":"types/classes/_event_.event.md","ref":"types/classes/_event_.event.md","articles":[]},"previous":{"title":"hidden","level":"4.31","depth":1,"path":"types/classes/_digest_.other.md","ref":"types/classes/_digest_.other.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_digest_.seal.md","mtime":"2019-01-25T10:38:53.696Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.32","depth":1,"next":{"title":"hidden","level":"4.33","depth":1,"path":"types/classes/_event_.event.md","ref":"types/classes/_event_.event.md","articles":[]},"previous":{"title":"hidden","level":"4.31","depth":1,"path":"types/classes/_digest_.other.md","ref":"types/classes/_digest_.other.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_digest_.seal.md","mtime":"2019-01-26T15:31:24.601Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_digest_.seal.md
+14 -14
View File
@@ -27,7 +27,7 @@
*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [Digest.ts:44](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Digest.ts#L44)*
*Defined in [Digest.ts:44](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Digest.ts#L44)*
**Parameters:**
@@ -49,7 +49,7 @@ getTypes(): `Array`<`string`>
*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)*
*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L68)*
*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L68)*
*__description__*: The types definition of the tuple
@@ -64,7 +64,7 @@ getencodedLength(): `number`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)*
*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L59)*
*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L59)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -77,7 +77,7 @@ ___
getsignature(): [Signature](_signature_.signature.md)
*Defined in [Digest.ts:55](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Digest.ts#L55)*
*Defined in [Digest.ts:55](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Digest.ts#L55)*
*__description__*: The wrapped [Signature](_signature_.signature.md)
@@ -90,7 +90,7 @@ ___
getslot(): [U64](_u64_.u64.md)
*Defined in [Digest.ts:62](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Digest.ts#L62)*
*Defined in [Digest.ts:62](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Digest.ts#L62)*
*__description__*: The wrapped [U64](_u64_.u64.md) slot
@@ -110,7 +110,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)*
*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L77)*
*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L77)*
*__description__*: Compares the value of the input to see if there is a match
@@ -133,7 +133,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L133)*
*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L133)*
*__description__*: Filters the array with the callback
@@ -157,7 +157,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L142)*
*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L142)*
*__description__*: Maps the array with the callback
@@ -182,7 +182,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)*
*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L84)*
*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L84)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -199,7 +199,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)*
*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L91)*
*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L91)*
*__description__*: Returns a hex string representation of the value
@@ -216,7 +216,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L98)*
*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L98)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -235,7 +235,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L107)*
*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L107)*
*__description__*: Returns the string representation of the value
@@ -252,7 +252,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)*
*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L116)*
*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L116)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -273,7 +273,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L48)*
*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L48)*
**Parameters:**
docs/types/classes/_event_.event.html
+26 -26
View File
@@ -2154,7 +2154,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Event</strong>(<em>value?: *[Uint8Array](_codec_u8a</em>.u8a.md#uint8array)*): <a href="_event_.event.html">Event</a></p>
<p><em>Overrides <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L86" target="_blank">Event.ts:86</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L86" target="_blank">Event.ts:86</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2177,14 +2177,14 @@
<h2 id="type">Type</h2>
<p>getType(): <code>E</code></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#type">Type</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L142" target="_blank">codec/Struct.ts:142</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L142" target="_blank">codec/Struct.ts:142</a></em></p>
<p><em><strong>description</strong></em>: Returns the Type description to sthe structure</p>
<p><strong>Returns:</strong> <code>E</code></p>
<hr>
<p><a id="data"></a></p>
<h2 id="data">data</h2>
<p>getdata(): <a href="_event_.eventdata.html">EventData</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L144" target="_blank">Event.ts:144</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L144" target="_blank">Event.ts:144</a></em></p>
<p><em><strong>description</strong></em>: The wrapped <a href="_event_.eventdata.html">EventData</a></p>
<p><strong>Returns:</strong> <a href="_event_.eventdata.html">EventData</a></p>
<hr>
@@ -2192,42 +2192,42 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L149" target="_blank">codec/Struct.ts:149</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L149" target="_blank">codec/Struct.ts:149</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="index"></a></p>
<h2 id="index">index</h2>
<p>getindex(): <a href="_event_.eventindex.html">EventIndex</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L151" target="_blank">Event.ts:151</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L151" target="_blank">Event.ts:151</a></em></p>
<p><em><strong>description</strong></em>: The <a href="_event_.eventindex.html">EventIndex</a>, identifying the raw event</p>
<p><strong>Returns:</strong> <a href="_event_.eventindex.html">EventIndex</a></p>
<hr>
<p><a id="meta"></a></p>
<h2 id="meta">meta</h2>
<p>getmeta(): <a href="_metadata_events_.eventmetadata.md">EventMetadata</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L158" target="_blank">Event.ts:158</a></em></p>
<p><em><strong>description</strong></em>: The <a href="_metadata_events_.eventmetadata.md">EventMetadata</a> with the documentation</p>
<p><strong>Returns:</strong> <a href="_metadata_events_.eventmetadata.md">EventMetadata</a></p>
<p>getmeta(): <a href="_metadata_v0_events_.eventmetadata.md">EventMetadata</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L158" target="_blank">Event.ts:158</a></em></p>
<p><em><strong>description</strong></em>: The <a href="_metadata_v0_events_.eventmetadata.md">EventMetadata</a> with the documentation</p>
<p><strong>Returns:</strong> <a href="_metadata_v0_events_.eventmetadata.md">EventMetadata</a></p>
<hr>
<p><a id="method"></a></p>
<h2 id="method">method</h2>
<p>getmethod(): <code>string</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L165" target="_blank">Event.ts:165</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L165" target="_blank">Event.ts:165</a></em></p>
<p><em><strong>description</strong></em>: The method string identifying the event</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
<p><a id="section"></a></p>
<h2 id="section">section</h2>
<p>getsection(): <code>string</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L172" target="_blank">Event.ts:172</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L172" target="_blank">Event.ts:172</a></em></p>
<p><em><strong>description</strong></em>: The section string identifying the event</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
<p><a id="typedef"></a></p>
<h2 id="typedef">typeDef</h2>
<p>gettypeDef(): <code>Array</code>&lt;<a href="../modules/_types_.md#typedef">TypeDef</a>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L179" target="_blank">Event.ts:179</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L179" target="_blank">Event.ts:179</a></em></p>
<p><em><strong>description</strong></em>: The <a href="../modules/_types_.md#typedef">TypeDef</a> for the event</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<a href="../modules/_types_.md#typedef">TypeDef</a>&gt;</p>
<hr>
@@ -2237,7 +2237,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L158" target="_blank">codec/Struct.ts:158</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L158" target="_blank">codec/Struct.ts:158</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2261,7 +2261,7 @@
<p>&#x25B8; <strong>get</strong>(name: <em><code>keyof S</code></em>): <a href="../interfaces/_types_.codec.md">Codec</a> | <code>undefined</code></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#get">get</a></em></p>
<p><em>Overrides Map.get</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L166" target="_blank">codec/Struct.ts:166</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L166" target="_blank">codec/Struct.ts:166</a></em></p>
<p><em><strong>description</strong></em>: Returns a specific names entry in the structure</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2286,7 +2286,7 @@
<h2 id="getatindex">getAtIndex</h2>
<p>&#x25B8; <strong>getAtIndex</strong>(index: <em><code>number</code></em>): <a href="../interfaces/_types_.codec.md">Codec</a></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#getatindex">getAtIndex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L173" target="_blank">codec/Struct.ts:173</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L173" target="_blank">codec/Struct.ts:173</a></em></p>
<p><em><strong>description</strong></em>: Returns the values of a member at a specific index (Rather use get(name) for performance)</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2309,7 +2309,7 @@
<h2 id="toarray">toArray</h2>
<p>&#x25B8; <strong>toArray</strong>(): <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#toarray">toArray</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L180" target="_blank">codec/Struct.ts:180</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L180" target="_blank">codec/Struct.ts:180</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to an standard JavaScript Array</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<hr>
@@ -2318,7 +2318,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L187" target="_blank">codec/Struct.ts:187</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L187" target="_blank">codec/Struct.ts:187</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2327,7 +2327,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L194" target="_blank">codec/Struct.ts:194</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L194" target="_blank">codec/Struct.ts:194</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2336,7 +2336,7 @@
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L208" target="_blank">codec/Struct.ts:208</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L208" target="_blank">codec/Struct.ts:208</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2345,7 +2345,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L216" target="_blank">codec/Struct.ts:216</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L216" target="_blank">codec/Struct.ts:216</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2371,7 +2371,7 @@
<p><a id="decodeevent"></a></p>
<h2 id="static-decodeevent"><code>&lt;Static&gt;</code> decodeEvent</h2>
<p>&#x25B8; <strong>decodeEvent</strong>(value?: <em><code>Uint8Array</code></em>): <code>object</code> | <code>object</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L98" target="_blank">Event.ts:98</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L98" target="_blank">Event.ts:98</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2393,8 +2393,8 @@
<hr>
<p><a id="injectmetadata"></a></p>
<h2 id="static-injectmetadata"><code>&lt;Static&gt;</code> injectMetadata</h2>
<p>&#x25B8; <strong>injectMetadata</strong>(metadata: <em><a href="_metadata_index_.metadata.md">Metadata</a></em>): <code>void</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L122" target="_blank">Event.ts:122</a></em></p>
<p>&#x25B8; <strong>injectMetadata</strong>(metadata: <em><a href="_metadata_v0_index_.metadatav0.md">MetadataV0</a></em>): <code>void</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L122" target="_blank">Event.ts:122</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2406,7 +2406,7 @@
<tbody>
<tr>
<td>metadata</td>
<td><a href="_metadata_index_.metadata.md">Metadata</a></td>
<td><a href="_metadata_v0_index_.metadatav0.md">MetadataV0</a></td>
</tr>
</tbody>
</table>
@@ -2416,7 +2416,7 @@
<h2 id="static-with"><code>&lt;Static&gt;</code> with</h2>
<p>&#x25B8; <strong>with</strong>&lt;<code>S</code>&gt;(Types: <em><code>S</code></em>): <a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_struct_.struct.html">Struct</a>&lt;<code>S</code>&gt;&gt;</p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#with">with</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L122" target="_blank">codec/Struct.ts:122</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L122" target="_blank">codec/Struct.ts:122</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="s---constructordef">S : <a href="../modules/_types_.md#constructordef">ConstructorDef</a></h4>
<p><strong>Parameters:</strong></p>
@@ -2479,7 +2479,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.33","depth":1,"next":{"title":"hidden","level":"4.34","depth":1,"path":"types/classes/_event_.eventdata.md","ref":"types/classes/_event_.eventdata.md","articles":[]},"previous":{"title":"hidden","level":"4.32","depth":1,"path":"types/classes/_digest_.seal.md","ref":"types/classes/_digest_.seal.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_event_.event.md","mtime":"2019-01-25T10:38:53.864Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.33","depth":1,"next":{"title":"hidden","level":"4.34","depth":1,"path":"types/classes/_event_.eventdata.md","ref":"types/classes/_event_.eventdata.md","articles":[]},"previous":{"title":"hidden","level":"4.32","depth":1,"path":"types/classes/_digest_.seal.md","ref":"types/classes/_digest_.seal.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_event_.event.md","mtime":"2019-01-26T15:31:24.653Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_event_.event.md
+25 -25
View File
@@ -29,7 +29,7 @@
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Event.ts:86](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L86)*
*Defined in [Event.ts:86](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L86)*
**Parameters:**
@@ -51,7 +51,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L142)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L142)*
*__description__*: Returns the Type description to sthe structure
@@ -64,7 +64,7 @@ ___
getdata(): [EventData](_event_.eventdata.md)
*Defined in [Event.ts:144](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L144)*
*Defined in [Event.ts:144](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L144)*
*__description__*: The wrapped [EventData](_event_.eventdata.md)
@@ -79,7 +79,7 @@ getencodedLength(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L149)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L149)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -92,7 +92,7 @@ ___
getindex(): [EventIndex](_event_.eventindex.md)
*Defined in [Event.ts:151](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L151)*
*Defined in [Event.ts:151](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L151)*
*__description__*: The [EventIndex](_event_.eventindex.md), identifying the raw event
@@ -103,13 +103,13 @@ ___
## meta
getmeta(): [EventMetadata](_metadata_events_.eventmetadata.md)
getmeta(): [EventMetadata](_metadata_v0_events_.eventmetadata.md)
*Defined in [Event.ts:158](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L158)*
*Defined in [Event.ts:158](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L158)*
*__description__*: The [EventMetadata](_metadata_events_.eventmetadata.md) with the documentation
*__description__*: The [EventMetadata](_metadata_v0_events_.eventmetadata.md) with the documentation
**Returns:** [EventMetadata](_metadata_events_.eventmetadata.md)
**Returns:** [EventMetadata](_metadata_v0_events_.eventmetadata.md)
___
<a id="method"></a>
@@ -118,7 +118,7 @@ ___
getmethod(): `string`
*Defined in [Event.ts:165](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L165)*
*Defined in [Event.ts:165](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L165)*
*__description__*: The method string identifying the event
@@ -131,7 +131,7 @@ ___
getsection(): `string`
*Defined in [Event.ts:172](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L172)*
*Defined in [Event.ts:172](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L172)*
*__description__*: The section string identifying the event
@@ -144,7 +144,7 @@ ___
gettypeDef(): `Array`<[TypeDef](../modules/_types_.md#typedef)>
*Defined in [Event.ts:179](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L179)*
*Defined in [Event.ts:179](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L179)*
*__description__*: The [TypeDef](../modules/_types_.md#typedef) for the event
@@ -164,7 +164,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L158)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L158)*
*__description__*: Compares the value of the input to see if there is a match
@@ -187,7 +187,7 @@ ___
*Overrides Map.get*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L166)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Returns a specific names entry in the structure
@@ -208,7 +208,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L173)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L173)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -229,7 +229,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L180)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -246,7 +246,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L187)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L187)*
*__description__*: Returns a hex string representation of the value
@@ -263,7 +263,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L194)*
*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L194)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -280,7 +280,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L208)*
*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L208)*
*__description__*: Returns the string representation of the value
@@ -297,7 +297,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L216)*
*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L216)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -316,7 +316,7 @@ ___
▸ **decodeEvent**(value?: *`Uint8Array`*): `object` | `object`
*Defined in [Event.ts:98](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L98)*
*Defined in [Event.ts:98](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L98)*
**Parameters:**
@@ -331,15 +331,15 @@ ___
## `<Static>` injectMetadata
▸ **injectMetadata**(metadata: *[Metadata](_metadata_index_.metadata.md)*): `void`
▸ **injectMetadata**(metadata: *[MetadataV0](_metadata_v0_index_.metadatav0.md)*): `void`
*Defined in [Event.ts:122](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L122)*
*Defined in [Event.ts:122](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L122)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| metadata | [Metadata](_metadata_index_.metadata.md) |
| metadata | [MetadataV0](_metadata_v0_index_.metadatav0.md) |
**Returns:** `void`
@@ -352,7 +352,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L122)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L122)*
**Type parameters:**
docs/types/classes/_event_.eventdata.html
+22 -22
View File
@@ -2149,9 +2149,9 @@
<h1 id="constructors">Constructors</h1>
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new EventData</strong>(Types: <em><code>Array</code>&lt;<a href="../modules/_types_.md#constructor">Constructor</a>&gt;</em>, value: <em><code>Uint8Array</code></em>, typeDef: <em><code>Array</code>&lt;<a href="../modules/_types_.md#typedef">TypeDef</a>&gt;</em>, meta: <em><a href="_metadata_events_.eventmetadata.md">EventMetadata</a></em>, section: <em><code>string</code></em>, method: <em><code>string</code></em>): <a href="_event_.eventdata.html">EventData</a></p>
<p>&#x2295; <strong>new EventData</strong>(Types: <em><code>Array</code>&lt;<a href="../modules/_types_.md#constructor">Constructor</a>&gt;</em>, value: <em><code>Uint8Array</code></em>, typeDef: <em><code>Array</code>&lt;<a href="../modules/_types_.md#typedef">TypeDef</a>&gt;</em>, meta: <em><a href="_metadata_v0_events_.eventmetadata.md">EventMetadata</a></em>, section: <em><code>string</code></em>, method: <em><code>string</code></em>): <a href="_event_.eventdata.html">EventData</a></p>
<p><em>Overrides <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L28" target="_blank">Event.ts:28</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L28" target="_blank">Event.ts:28</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2175,7 +2175,7 @@
</tr>
<tr>
<td>meta</td>
<td><a href="_metadata_events_.eventmetadata.md">EventMetadata</a></td>
<td><a href="_metadata_v0_events_.eventmetadata.md">EventMetadata</a></td>
</tr>
<tr>
<td>section</td>
@@ -2194,7 +2194,7 @@
<h2 id="types">Types</h2>
<p>getTypes(): <code>Array</code>&lt;<code>string</code>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#types">Types</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L68" target="_blank">codec/Tuple.ts:68</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L68" target="_blank">codec/Tuple.ts:68</a></em></p>
<p><em><strong>description</strong></em>: The types definition of the tuple</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<code>string</code>&gt;</p>
<hr>
@@ -2202,35 +2202,35 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L59" target="_blank">codec/Tuple.ts:59</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L59" target="_blank">codec/Tuple.ts:59</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="meta"></a></p>
<h2 id="meta">meta</h2>
<p>getmeta(): <a href="_metadata_events_.eventmetadata.md">EventMetadata</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L42" target="_blank">Event.ts:42</a></em></p>
<p><em><strong>description</strong></em>: The wrapped <a href="_metadata_events_.eventmetadata.md">EventMetadata</a></p>
<p><strong>Returns:</strong> <a href="_metadata_events_.eventmetadata.md">EventMetadata</a></p>
<p>getmeta(): <a href="_metadata_v0_events_.eventmetadata.md">EventMetadata</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L42" target="_blank">Event.ts:42</a></em></p>
<p><em><strong>description</strong></em>: The wrapped <a href="_metadata_v0_events_.eventmetadata.md">EventMetadata</a></p>
<p><strong>Returns:</strong> <a href="_metadata_v0_events_.eventmetadata.md">EventMetadata</a></p>
<hr>
<p><a id="method"></a></p>
<h2 id="method">method</h2>
<p>getmethod(): <code>string</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L49" target="_blank">Event.ts:49</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L49" target="_blank">Event.ts:49</a></em></p>
<p><em><strong>description</strong></em>: The method as a string</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
<p><a id="section"></a></p>
<h2 id="section">section</h2>
<p>getsection(): <code>string</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L56" target="_blank">Event.ts:56</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L56" target="_blank">Event.ts:56</a></em></p>
<p><em><strong>description</strong></em>: The section as a string</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
<p><a id="typedef"></a></p>
<h2 id="typedef">typeDef</h2>
<p>gettypeDef(): <code>Array</code>&lt;<a href="../modules/_types_.md#typedef">TypeDef</a>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L63" target="_blank">Event.ts:63</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L63" target="_blank">Event.ts:63</a></em></p>
<p><em><strong>description</strong></em>: The <a href="../modules/_types_.md#typedef">TypeDef</a> for this event</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<a href="../modules/_types_.md#typedef">TypeDef</a>&gt;</p>
<hr>
@@ -2240,7 +2240,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L77" target="_blank">codec/Tuple.ts:77</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L77" target="_blank">codec/Tuple.ts:77</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2264,7 +2264,7 @@
<p>&#x25B8; <strong>filter</strong>(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#filter">filter</a></em></p>
<p><em>Overrides Array.filter</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L133" target="_blank">codec/Tuple.ts:133</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L133" target="_blank">codec/Tuple.ts:133</a></em></p>
<p><em><strong>description</strong></em>: Filters the array with the callback</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2295,7 +2295,7 @@
<p>&#x25B8; <strong>map</strong>&lt;<code>U</code>&gt;(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code>&lt;<code>U</code>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#map">map</a></em></p>
<p><em>Overrides Array.map</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L142" target="_blank">codec/Tuple.ts:142</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L142" target="_blank">codec/Tuple.ts:142</a></em></p>
<p><em><strong>description</strong></em>: Maps the array with the callback</p>
<p><strong>Type parameters:</strong></p>
<h4 id="u">U</h4>
@@ -2327,7 +2327,7 @@
<h2 id="toarray">toArray</h2>
<p>&#x25B8; <strong>toArray</strong>(): <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#toarray">toArray</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L84" target="_blank">codec/Tuple.ts:84</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L84" target="_blank">codec/Tuple.ts:84</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to an standard JavaScript Array</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<hr>
@@ -2336,7 +2336,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L91" target="_blank">codec/Tuple.ts:91</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L91" target="_blank">codec/Tuple.ts:91</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2345,7 +2345,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L98" target="_blank">codec/Tuple.ts:98</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L98" target="_blank">codec/Tuple.ts:98</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2355,7 +2355,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tostring">toString</a></em></p>
<p><em>Overrides Array.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L107" target="_blank">codec/Tuple.ts:107</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L107" target="_blank">codec/Tuple.ts:107</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2364,7 +2364,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L116" target="_blank">codec/Tuple.ts:116</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L116" target="_blank">codec/Tuple.ts:116</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2391,7 +2391,7 @@
<h2 id="static-with"><code>&lt;Static&gt;</code> with</h2>
<p>&#x25B8; <strong>with</strong>(Types: <em><code>TupleConstructors</code></em>): <a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_tuple_.tuple.html">Tuple</a>&gt;</p>
<p><em>Inherited from <a href="_codec_tuple_.tuple.html">Tuple</a>.<a href="_codec_tuple_.tuple.html#with">with</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L48" target="_blank">codec/Tuple.ts:48</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L48" target="_blank">codec/Tuple.ts:48</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2452,7 +2452,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.34","depth":1,"next":{"title":"hidden","level":"4.35","depth":1,"path":"types/classes/_event_.eventindex.md","ref":"types/classes/_event_.eventindex.md","articles":[]},"previous":{"title":"hidden","level":"4.33","depth":1,"path":"types/classes/_event_.event.md","ref":"types/classes/_event_.event.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_event_.eventdata.md","mtime":"2019-01-25T10:38:53.940Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.34","depth":1,"next":{"title":"hidden","level":"4.35","depth":1,"path":"types/classes/_event_.eventindex.md","ref":"types/classes/_event_.eventindex.md","articles":[]},"previous":{"title":"hidden","level":"4.33","depth":1,"path":"types/classes/_event_.event.md","ref":"types/classes/_event_.event.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_event_.eventdata.md","mtime":"2019-01-26T15:31:24.701Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_event_.eventdata.md
+21 -21
View File
@@ -23,11 +23,11 @@
## constructor
⊕ **new EventData**(Types: *`Array`<[Constructor](../modules/_types_.md#constructor)>*, value: *`Uint8Array`*, typeDef: *`Array`<[TypeDef](../modules/_types_.md#typedef)>*, meta: *[EventMetadata](_metadata_events_.eventmetadata.md)*, section: *`string`*, method: *`string`*): [EventData](_event_.eventdata.md)
⊕ **new EventData**(Types: *`Array`<[Constructor](../modules/_types_.md#constructor)>*, value: *`Uint8Array`*, typeDef: *`Array`<[TypeDef](../modules/_types_.md#typedef)>*, meta: *[EventMetadata](_metadata_v0_events_.eventmetadata.md)*, section: *`string`*, method: *`string`*): [EventData](_event_.eventdata.md)
*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [Event.ts:28](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L28)*
*Defined in [Event.ts:28](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L28)*
**Parameters:**
@@ -36,7 +36,7 @@
| Types | `Array`<[Constructor](../modules/_types_.md#constructor)> |
| value | `Uint8Array` |
| typeDef | `Array`<[TypeDef](../modules/_types_.md#typedef)> |
| meta | [EventMetadata](_metadata_events_.eventmetadata.md) |
| meta | [EventMetadata](_metadata_v0_events_.eventmetadata.md) |
| section | `string` |
| method | `string` |
@@ -54,7 +54,7 @@ getTypes(): `Array`<`string`>
*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)*
*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L68)*
*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L68)*
*__description__*: The types definition of the tuple
@@ -69,7 +69,7 @@ getencodedLength(): `number`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)*
*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L59)*
*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L59)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -80,13 +80,13 @@ ___
## meta
getmeta(): [EventMetadata](_metadata_events_.eventmetadata.md)
getmeta(): [EventMetadata](_metadata_v0_events_.eventmetadata.md)
*Defined in [Event.ts:42](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L42)*
*Defined in [Event.ts:42](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L42)*
*__description__*: The wrapped [EventMetadata](_metadata_events_.eventmetadata.md)
*__description__*: The wrapped [EventMetadata](_metadata_v0_events_.eventmetadata.md)
**Returns:** [EventMetadata](_metadata_events_.eventmetadata.md)
**Returns:** [EventMetadata](_metadata_v0_events_.eventmetadata.md)
___
<a id="method"></a>
@@ -95,7 +95,7 @@ ___
getmethod(): `string`
*Defined in [Event.ts:49](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L49)*
*Defined in [Event.ts:49](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L49)*
*__description__*: The method as a string
@@ -108,7 +108,7 @@ ___
getsection(): `string`
*Defined in [Event.ts:56](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L56)*
*Defined in [Event.ts:56](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L56)*
*__description__*: The section as a string
@@ -121,7 +121,7 @@ ___
gettypeDef(): `Array`<[TypeDef](../modules/_types_.md#typedef)>
*Defined in [Event.ts:63](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L63)*
*Defined in [Event.ts:63](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L63)*
*__description__*: The [TypeDef](../modules/_types_.md#typedef) for this event
@@ -141,7 +141,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)*
*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L77)*
*Defined in [codec/Tuple.ts:77](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L77)*
*__description__*: Compares the value of the input to see if there is a match
@@ -164,7 +164,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L133)*
*Defined in [codec/Tuple.ts:133](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L133)*
*__description__*: Filters the array with the callback
@@ -188,7 +188,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L142)*
*Defined in [codec/Tuple.ts:142](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L142)*
*__description__*: Maps the array with the callback
@@ -213,7 +213,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)*
*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L84)*
*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L84)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -230,7 +230,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)*
*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L91)*
*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L91)*
*__description__*: Returns a hex string representation of the value
@@ -247,7 +247,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L98)*
*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L98)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -266,7 +266,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L107)*
*Defined in [codec/Tuple.ts:107](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L107)*
*__description__*: Returns the string representation of the value
@@ -283,7 +283,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)*
*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L116)*
*Defined in [codec/Tuple.ts:116](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L116)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -304,7 +304,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Tuple.ts#L48)*
*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Tuple.ts#L48)*
**Parameters:**
docs/types/classes/_event_.eventindex.html
+12 -12
View File
@@ -2151,7 +2151,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new EventIndex</strong>(value?: <em><code>any</code></em>): <a href="_event_.eventindex.html">EventIndex</a></p>
<p><em>Overrides <a href="_codec_u8afixed_.u8afixed.html">U8aFixed</a>.<a href="_codec_u8afixed_.u8afixed.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L74" target="_blank">Event.ts:74</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L74" target="_blank">Event.ts:74</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2174,7 +2174,7 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2182,7 +2182,7 @@
<h2 id="isempty">isEmpty</h2>
<p>getisEmpty(): <code>boolean</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#isempty">isEmpty</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em><strong>description</strong></em>: Returns true if the type wraps an empty/default all-0 value</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
@@ -2191,7 +2191,7 @@
<p>getlength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#length">length</a></em></p>
<p><em>Overrides Uint8Array.length</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50" target="_blank">codec/U8a.ts:50</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50" target="_blank">codec/U8a.ts:50</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2200,7 +2200,7 @@
<h2 id="bitlength">bitLength</h2>
<p>&#x25B8; <strong>bitLength</strong>(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8afixed_.u8afixed.html">U8aFixed</a>.<a href="_codec_u8afixed_.u8afixed.html#bitlength">bitLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8aFixed.ts#L52" target="_blank">codec/U8aFixed.ts:52</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8aFixed.ts#L52" target="_blank">codec/U8aFixed.ts:52</a></em></p>
<p><em><strong>description</strong></em>: Returns the number of bits in the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2209,7 +2209,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L58" target="_blank">codec/U8a.ts:58</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L58" target="_blank">codec/U8a.ts:58</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2233,7 +2233,7 @@
<p>&#x25B8; <strong>subarray</strong>(begin: <em><code>number</code></em>, end?: <em><code>undefined</code> | <code>number</code></em>): <code>Uint8Array</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#subarray">subarray</a></em></p>
<p><em>Overrides Uint8Array.subarray</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73" target="_blank">codec/U8a.ts:73</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73" target="_blank">codec/U8a.ts:73</a></em></p>
<p><em><strong>description</strong></em>: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2265,7 +2265,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80" target="_blank">codec/U8a.ts:80</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80" target="_blank">codec/U8a.ts:80</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2274,7 +2274,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L87" target="_blank">codec/U8a.ts:87</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L87" target="_blank">codec/U8a.ts:87</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2284,7 +2284,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tostring">toString</a></em></p>
<p><em>Overrides Uint8Array.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L94" target="_blank">codec/U8a.ts:94</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L94" target="_blank">codec/U8a.ts:94</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2293,7 +2293,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L102" target="_blank">codec/U8a.ts:102</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L102" target="_blank">codec/U8a.ts:102</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2359,7 +2359,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.35","depth":1,"next":{"title":"hidden","level":"4.36","depth":1,"path":"types/classes/_eventrecord_.applyextrinsic.md","ref":"types/classes/_eventrecord_.applyextrinsic.md","articles":[]},"previous":{"title":"hidden","level":"4.34","depth":1,"path":"types/classes/_event_.eventdata.md","ref":"types/classes/_event_.eventdata.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_event_.eventindex.md","mtime":"2019-01-25T10:38:53.972Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.35","depth":1,"next":{"title":"hidden","level":"4.36","depth":1,"path":"types/classes/_eventrecord_.applyextrinsic.md","ref":"types/classes/_eventrecord_.applyextrinsic.md","articles":[]},"previous":{"title":"hidden","level":"4.34","depth":1,"path":"types/classes/_event_.eventdata.md","ref":"types/classes/_event_.eventdata.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_event_.eventindex.md","mtime":"2019-01-26T15:31:24.737Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_event_.eventindex.md
+11 -11
View File
@@ -27,7 +27,7 @@
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [Event.ts:74](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Event.ts#L74)*
*Defined in [Event.ts:74](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Event.ts#L74)*
**Parameters:**
@@ -49,7 +49,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -64,7 +64,7 @@ getisEmpty(): `boolean`
*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43)*
*__description__*: Returns true if the type wraps an empty/default all-0 value
@@ -81,7 +81,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50)*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50)*
*__description__*: The length of the value
@@ -99,7 +99,7 @@ ___
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8aFixed.ts#L52)*
*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8aFixed.ts#L52)*
*__description__*: Returns the number of bits in the value
@@ -116,7 +116,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L58)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L58)*
*__description__*: Compares the value of the input to see if there is a match
@@ -139,7 +139,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73)*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -163,7 +163,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80)*
*__description__*: Returns a hex string representation of the value
@@ -180,7 +180,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L87)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L87)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -199,7 +199,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L94)*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L94)*
*__description__*: Returns the string representation of the value
@@ -216,7 +216,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L102)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L102)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_eventrecord_.applyextrinsic.html
+4 -4
View File
@@ -2150,7 +2150,7 @@
<p>&#x2295; <strong>new ApplyExtrinsic</strong>(value?: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>): <a href="_eventrecord_.applyextrinsic.html">ApplyExtrinsic</a></p>
<p><em>Inherited from <a href="_u32_.u32.html">U32</a>.<a href="_u32_.u32.html#constructor">constructor</a></em></p>
<p><em>Overrides <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/U32.ts#L14" target="_blank">U32.ts:14</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/U32.ts#L14" target="_blank">U32.ts:14</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2175,7 +2175,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tohex">toHex</a></em></p>
<p><em>Overrides AbstractInt.toHex</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/UInt.ts#L36" target="_blank">codec/UInt.ts:36</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/UInt.ts#L36" target="_blank">codec/UInt.ts:36</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2185,7 +2185,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tou8a">toU8a</a></em></p>
<p><em>Overrides AbstractInt.toU8a</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/UInt.ts#L48" target="_blank">codec/UInt.ts:48</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/UInt.ts#L48" target="_blank">codec/UInt.ts:48</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2251,7 +2251,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.36","depth":1,"next":{"title":"hidden","level":"4.37","depth":1,"path":"types/classes/_eventrecord_.eventrecord.md","ref":"types/classes/_eventrecord_.eventrecord.md","articles":[]},"previous":{"title":"hidden","level":"4.35","depth":1,"path":"types/classes/_event_.eventindex.md","ref":"types/classes/_event_.eventindex.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_eventrecord_.applyextrinsic.md","mtime":"2019-01-25T10:38:53.992Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.36","depth":1,"next":{"title":"hidden","level":"4.37","depth":1,"path":"types/classes/_eventrecord_.eventrecord.md","ref":"types/classes/_eventrecord_.eventrecord.md","articles":[]},"previous":{"title":"hidden","level":"4.35","depth":1,"path":"types/classes/_event_.eventindex.md","ref":"types/classes/_event_.eventindex.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_eventrecord_.applyextrinsic.md","mtime":"2019-01-26T15:31:24.749Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_eventrecord_.applyextrinsic.md
+3 -3
View File
@@ -26,7 +26,7 @@
*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)*
*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/U32.ts#L14)*
*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/U32.ts#L14)*
**Parameters:**
@@ -52,7 +52,7 @@ ___
*Overrides AbstractInt.toHex*
*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/UInt.ts#L36)*
*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/UInt.ts#L36)*
*__description__*: Returns a hex string representation of the value
@@ -71,7 +71,7 @@ ___
*Overrides AbstractInt.toU8a*
*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/UInt.ts#L48)*
*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/UInt.ts#L48)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_eventrecord_.eventrecord.html
+15 -15
View File
@@ -2154,7 +2154,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new EventRecord</strong>(value: <em><code>any</code></em>): <a href="_eventrecord_.eventrecord.html">EventRecord</a></p>
<p><em>Overrides <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/EventRecord.ts#L61" target="_blank">EventRecord.ts:61</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/EventRecord.ts#L61" target="_blank">EventRecord.ts:61</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2177,7 +2177,7 @@
<h2 id="type">Type</h2>
<p>getType(): <code>E</code></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#type">Type</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L142" target="_blank">codec/Struct.ts:142</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L142" target="_blank">codec/Struct.ts:142</a></em></p>
<p><em><strong>description</strong></em>: Returns the Type description to sthe structure</p>
<p><strong>Returns:</strong> <code>E</code></p>
<hr>
@@ -2185,21 +2185,21 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L149" target="_blank">codec/Struct.ts:149</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L149" target="_blank">codec/Struct.ts:149</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="event"></a></p>
<h2 id="event">event</h2>
<p>getevent(): <a href="_event_.event.html">Event</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/EventRecord.ts#L72" target="_blank">EventRecord.ts:72</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/EventRecord.ts#L72" target="_blank">EventRecord.ts:72</a></em></p>
<p><em><strong>description</strong></em>: The <a href="_event_.event.html">Event</a> this record refers to</p>
<p><strong>Returns:</strong> <a href="_event_.event.html">Event</a></p>
<hr>
<p><a id="phase"></a></p>
<h2 id="phase">phase</h2>
<p>getphase(): <a href="_eventrecord_.phase.html">Phase</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/EventRecord.ts#L79" target="_blank">EventRecord.ts:79</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/EventRecord.ts#L79" target="_blank">EventRecord.ts:79</a></em></p>
<p><em><strong>description</strong></em>: The <a href="_eventrecord_.phase.html">Phase</a> where the event was generated</p>
<p><strong>Returns:</strong> <a href="_eventrecord_.phase.html">Phase</a></p>
<hr>
@@ -2209,7 +2209,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L158" target="_blank">codec/Struct.ts:158</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L158" target="_blank">codec/Struct.ts:158</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2233,7 +2233,7 @@
<p>&#x25B8; <strong>get</strong>(name: <em><code>keyof S</code></em>): <a href="../interfaces/_types_.codec.md">Codec</a> | <code>undefined</code></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#get">get</a></em></p>
<p><em>Overrides Map.get</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L166" target="_blank">codec/Struct.ts:166</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L166" target="_blank">codec/Struct.ts:166</a></em></p>
<p><em><strong>description</strong></em>: Returns a specific names entry in the structure</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2258,7 +2258,7 @@
<h2 id="getatindex">getAtIndex</h2>
<p>&#x25B8; <strong>getAtIndex</strong>(index: <em><code>number</code></em>): <a href="../interfaces/_types_.codec.md">Codec</a></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#getatindex">getAtIndex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L173" target="_blank">codec/Struct.ts:173</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L173" target="_blank">codec/Struct.ts:173</a></em></p>
<p><em><strong>description</strong></em>: Returns the values of a member at a specific index (Rather use get(name) for performance)</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2281,7 +2281,7 @@
<h2 id="toarray">toArray</h2>
<p>&#x25B8; <strong>toArray</strong>(): <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#toarray">toArray</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L180" target="_blank">codec/Struct.ts:180</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L180" target="_blank">codec/Struct.ts:180</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to an standard JavaScript Array</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<hr>
@@ -2290,7 +2290,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L187" target="_blank">codec/Struct.ts:187</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L187" target="_blank">codec/Struct.ts:187</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2299,7 +2299,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L194" target="_blank">codec/Struct.ts:194</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L194" target="_blank">codec/Struct.ts:194</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2308,7 +2308,7 @@
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L208" target="_blank">codec/Struct.ts:208</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L208" target="_blank">codec/Struct.ts:208</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2317,7 +2317,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L216" target="_blank">codec/Struct.ts:216</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L216" target="_blank">codec/Struct.ts:216</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2344,7 +2344,7 @@
<h2 id="static-with"><code>&lt;Static&gt;</code> with</h2>
<p>&#x25B8; <strong>with</strong>&lt;<code>S</code>&gt;(Types: <em><code>S</code></em>): <a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_struct_.struct.html">Struct</a>&lt;<code>S</code>&gt;&gt;</p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#with">with</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L122" target="_blank">codec/Struct.ts:122</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L122" target="_blank">codec/Struct.ts:122</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="s---constructordef">S : <a href="../modules/_types_.md#constructordef">ConstructorDef</a></h4>
<p><strong>Parameters:</strong></p>
@@ -2407,7 +2407,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.37","depth":1,"next":{"title":"hidden","level":"4.38","depth":1,"path":"types/classes/_eventrecord_.finalization.md","ref":"types/classes/_eventrecord_.finalization.md","articles":[]},"previous":{"title":"hidden","level":"4.36","depth":1,"path":"types/classes/_eventrecord_.applyextrinsic.md","ref":"types/classes/_eventrecord_.applyextrinsic.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_eventrecord_.eventrecord.md","mtime":"2019-01-25T10:38:54.024Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.37","depth":1,"next":{"title":"hidden","level":"4.38","depth":1,"path":"types/classes/_eventrecord_.finalization.md","ref":"types/classes/_eventrecord_.finalization.md","articles":[]},"previous":{"title":"hidden","level":"4.36","depth":1,"path":"types/classes/_eventrecord_.applyextrinsic.md","ref":"types/classes/_eventrecord_.applyextrinsic.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_eventrecord_.eventrecord.md","mtime":"2019-01-26T15:31:24.789Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_eventrecord_.eventrecord.md
+14 -14
View File
@@ -29,7 +29,7 @@
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [EventRecord.ts:61](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/EventRecord.ts#L61)*
*Defined in [EventRecord.ts:61](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/EventRecord.ts#L61)*
**Parameters:**
@@ -51,7 +51,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L142)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L142)*
*__description__*: Returns the Type description to sthe structure
@@ -66,7 +66,7 @@ getencodedLength(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L149)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L149)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -79,7 +79,7 @@ ___
getevent(): [Event](_event_.event.md)
*Defined in [EventRecord.ts:72](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/EventRecord.ts#L72)*
*Defined in [EventRecord.ts:72](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/EventRecord.ts#L72)*
*__description__*: The [Event](_event_.event.md) this record refers to
@@ -92,7 +92,7 @@ ___
getphase(): [Phase](_eventrecord_.phase.md)
*Defined in [EventRecord.ts:79](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/EventRecord.ts#L79)*
*Defined in [EventRecord.ts:79](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/EventRecord.ts#L79)*
*__description__*: The [Phase](_eventrecord_.phase.md) where the event was generated
@@ -112,7 +112,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L158)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L158)*
*__description__*: Compares the value of the input to see if there is a match
@@ -135,7 +135,7 @@ ___
*Overrides Map.get*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L166)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Returns a specific names entry in the structure
@@ -156,7 +156,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L173)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L173)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -177,7 +177,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L180)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -194,7 +194,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L187)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L187)*
*__description__*: Returns a hex string representation of the value
@@ -211,7 +211,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L194)*
*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L194)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -228,7 +228,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L208)*
*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L208)*
*__description__*: Returns the string representation of the value
@@ -245,7 +245,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L216)*
*Defined in [codec/Struct.ts:216](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L216)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -266,7 +266,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L122)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L122)*
**Type parameters:**
docs/types/classes/_eventrecord_.finalization.html
+7 -7
View File
@@ -2149,7 +2149,7 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_null_.null.html">Null</a>.<a href="_null_.null.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Null.ts#L17" target="_blank">Null.ts:17</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Null.ts#L17" target="_blank">Null.ts:17</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2159,7 +2159,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_null_.null.html">Null</a>.<a href="_null_.null.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Null.ts#L24" target="_blank">Null.ts:24</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Null.ts#L24" target="_blank">Null.ts:24</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2183,7 +2183,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_null_.null.html">Null</a>.<a href="_null_.null.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Null.ts#L31" target="_blank">Null.ts:31</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Null.ts#L31" target="_blank">Null.ts:31</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2192,7 +2192,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_null_.null.html">Null</a>.<a href="_null_.null.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Null.ts#L38" target="_blank">Null.ts:38</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Null.ts#L38" target="_blank">Null.ts:38</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2201,7 +2201,7 @@
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_null_.null.html">Null</a>.<a href="_null_.null.html#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Null.ts#L45" target="_blank">Null.ts:45</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Null.ts#L45" target="_blank">Null.ts:45</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2210,7 +2210,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_null_.null.html">Null</a>.<a href="_null_.null.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Null.ts#L53" target="_blank">Null.ts:53</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Null.ts#L53" target="_blank">Null.ts:53</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2276,7 +2276,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.38","depth":1,"next":{"title":"hidden","level":"4.39","depth":1,"path":"types/classes/_eventrecord_.phase.md","ref":"types/classes/_eventrecord_.phase.md","articles":[]},"previous":{"title":"hidden","level":"4.37","depth":1,"path":"types/classes/_eventrecord_.eventrecord.md","ref":"types/classes/_eventrecord_.eventrecord.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_eventrecord_.finalization.md","mtime":"2019-01-25T10:38:54.044Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.38","depth":1,"next":{"title":"hidden","level":"4.39","depth":1,"path":"types/classes/_eventrecord_.phase.md","ref":"types/classes/_eventrecord_.phase.md","articles":[]},"previous":{"title":"hidden","level":"4.37","depth":1,"path":"types/classes/_eventrecord_.eventrecord.md","ref":"types/classes/_eventrecord_.eventrecord.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_eventrecord_.finalization.md","mtime":"2019-01-26T15:31:24.813Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_eventrecord_.finalization.md
+6 -6
View File
@@ -24,7 +24,7 @@ getencodedLength(): `number`
*Inherited from [Null](_null_.null.md).[encodedLength](_null_.null.md#encodedlength)*
*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Null.ts#L17)*
*Defined in [Null.ts:17](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Null.ts#L17)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -44,7 +44,7 @@ ___
*Inherited from [Null](_null_.null.md).[eq](_null_.null.md#eq)*
*Defined in [Null.ts:24](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Null.ts#L24)*
*Defined in [Null.ts:24](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Null.ts#L24)*
*__description__*: Compares the value of the input to see if there is a match
@@ -67,7 +67,7 @@ ___
*Inherited from [Null](_null_.null.md).[toHex](_null_.null.md#tohex)*
*Defined in [Null.ts:31](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Null.ts#L31)*
*Defined in [Null.ts:31](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Null.ts#L31)*
*__description__*: Returns a hex string representation of the value
@@ -84,7 +84,7 @@ ___
*Inherited from [Null](_null_.null.md).[toJSON](_null_.null.md#tojson)*
*Defined in [Null.ts:38](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Null.ts#L38)*
*Defined in [Null.ts:38](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Null.ts#L38)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -101,7 +101,7 @@ ___
*Inherited from [Null](_null_.null.md).[toString](_null_.null.md#tostring)*
*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Null.ts#L45)*
*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Null.ts#L45)*
*__description__*: Returns the string representation of the value
@@ -118,7 +118,7 @@ ___
*Inherited from [Null](_null_.null.md).[toU8a](_null_.null.md#tou8a)*
*Defined in [Null.ts:53](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Null.ts#L53)*
*Defined in [Null.ts:53](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Null.ts#L53)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_eventrecord_.phase.html
+23 -15
View File
@@ -2149,7 +2149,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Phase</strong>(value: <em><code>any</code></em>, index?: <em><code>undefined</code> | <code>number</code></em>): <a href="_eventrecord_.phase.html">Phase</a></p>
<p><em>Overrides <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/EventRecord.ts#L32" target="_blank">EventRecord.ts:32</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/EventRecord.ts#L32" target="_blank">EventRecord.ts:32</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2176,14 +2176,14 @@
<p><a id="asapplyextrinsic"></a></p>
<h2 id="asapplyextrinsic">asApplyExtrinsic</h2>
<p>getasApplyExtrinsic(): <a href="_eventrecord_.applyextrinsic.html">ApplyExtrinsic</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/EventRecord.ts#L43" target="_blank">EventRecord.ts:43</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/EventRecord.ts#L43" target="_blank">EventRecord.ts:43</a></em></p>
<p><em><strong>description</strong></em>: Returns the item as a <a href="_eventrecord_.applyextrinsic.html">ApplyExtrinsic</a></p>
<p><strong>Returns:</strong> <a href="_eventrecord_.applyextrinsic.html">ApplyExtrinsic</a></p>
<hr>
<p><a id="asfinalization"></a></p>
<h2 id="asfinalization">asFinalization</h2>
<p>getasFinalization(): <a href="_eventrecord_.finalization.html">Finalization</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/EventRecord.ts#L50" target="_blank">EventRecord.ts:50</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/EventRecord.ts#L50" target="_blank">EventRecord.ts:50</a></em></p>
<p><em><strong>description</strong></em>: Returns the item as a <a href="_eventrecord_.finalization.html">Finalization</a></p>
<p><strong>Returns:</strong> <a href="_eventrecord_.finalization.html">Finalization</a></p>
<hr>
@@ -2191,15 +2191,23 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L101" target="_blank">codec/EnumType.ts:101</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L101" target="_blank">codec/EnumType.ts:101</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="index"></a></p>
<h2 id="index">index</h2>
<p>getindex(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#index">index</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L108" target="_blank">codec/EnumType.ts:108</a></em></p>
<p><em><strong>description</strong></em>: The index of the metadata value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="isnone"></a></p>
<h2 id="isnone">isNone</h2>
<p>getisNone(): <code>boolean</code></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#isnone">isNone</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L108" target="_blank">codec/EnumType.ts:108</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L115" target="_blank">codec/EnumType.ts:115</a></em></p>
<p><em><strong>description</strong></em>: Checks if the Enum points to a <a href="_null_.null.html">Null</a> type</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
@@ -2207,7 +2215,7 @@
<h2 id="isnull">isNull</h2>
<p>getisNull(): <code>boolean</code></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#isnull">isNull</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L115" target="_blank">codec/EnumType.ts:115</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L122" target="_blank">codec/EnumType.ts:122</a></em></p>
<p><em><strong>description</strong></em>: Checks if the Enum points to a <a href="_null_.null.html">Null</a> type (deprecated, use isNone)</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
@@ -2215,7 +2223,7 @@
<h2 id="type">type</h2>
<p>gettype(): <code>string</code></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#type">type</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L122" target="_blank">codec/EnumType.ts:122</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L129" target="_blank">codec/EnumType.ts:129</a></em></p>
<p><em><strong>description</strong></em>: The name of the type this enum value represents</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2223,7 +2231,7 @@
<h2 id="value">value</h2>
<p>getvalue(): <a href="../interfaces/_types_.codec.md">Codec</a></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#value">value</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L129" target="_blank">codec/EnumType.ts:129</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L136" target="_blank">codec/EnumType.ts:136</a></em></p>
<p><em><strong>description</strong></em>: The value of the enum</p>
<p><strong>Returns:</strong> <a href="../interfaces/_types_.codec.md">Codec</a></p>
<hr>
@@ -2233,7 +2241,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L136" target="_blank">codec/EnumType.ts:136</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L143" target="_blank">codec/EnumType.ts:143</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2257,7 +2265,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L149" target="_blank">codec/EnumType.ts:149</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L156" target="_blank">codec/EnumType.ts:156</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2266,7 +2274,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L156" target="_blank">codec/EnumType.ts:156</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L163" target="_blank">codec/EnumType.ts:163</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2274,7 +2282,7 @@
<h2 id="tonumber">toNumber</h2>
<p>&#x25B8; <strong>toNumber</strong>(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#tonumber">toNumber</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L163" target="_blank">codec/EnumType.ts:163</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L170" target="_blank">codec/EnumType.ts:170</a></em></p>
<p><em><strong>description</strong></em>: Returns the number representation for the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2283,7 +2291,7 @@
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L170" target="_blank">codec/EnumType.ts:170</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L177" target="_blank">codec/EnumType.ts:177</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2292,7 +2300,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_enumtype_.enumtype.html">EnumType</a>.<a href="_codec_enumtype_.enumtype.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L178" target="_blank">codec/EnumType.ts:178</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L185" target="_blank">codec/EnumType.ts:185</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2358,7 +2366,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.39","depth":1,"next":{"title":"hidden","level":"4.40","depth":1,"path":"types/classes/_extrinsic_.extrinsic.md","ref":"types/classes/_extrinsic_.extrinsic.md","articles":[]},"previous":{"title":"hidden","level":"4.38","depth":1,"path":"types/classes/_eventrecord_.finalization.md","ref":"types/classes/_eventrecord_.finalization.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_eventrecord_.phase.md","mtime":"2019-01-25T10:38:54.084Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.39","depth":1,"next":{"title":"hidden","level":"4.40","depth":1,"path":"types/classes/_extrinsic_.extrinsic.md","ref":"types/classes/_extrinsic_.extrinsic.md","articles":[]},"previous":{"title":"hidden","level":"4.38","depth":1,"path":"types/classes/_eventrecord_.finalization.md","ref":"types/classes/_eventrecord_.finalization.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_eventrecord_.phase.md","mtime":"2019-01-26T15:31:24.849Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_eventrecord_.phase.md
+29 -14
View File
@@ -24,7 +24,7 @@
*Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)*
*Defined in [EventRecord.ts:32](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/EventRecord.ts#L32)*
*Defined in [EventRecord.ts:32](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/EventRecord.ts#L32)*
**Parameters:**
@@ -45,7 +45,7 @@ ___
getasApplyExtrinsic(): [ApplyExtrinsic](_eventrecord_.applyextrinsic.md)
*Defined in [EventRecord.ts:43](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/EventRecord.ts#L43)*
*Defined in [EventRecord.ts:43](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/EventRecord.ts#L43)*
*__description__*: Returns the item as a [ApplyExtrinsic](_eventrecord_.applyextrinsic.md)
@@ -58,7 +58,7 @@ ___
getasFinalization(): [Finalization](_eventrecord_.finalization.md)
*Defined in [EventRecord.ts:50](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/EventRecord.ts#L50)*
*Defined in [EventRecord.ts:50](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/EventRecord.ts#L50)*
*__description__*: Returns the item as a [Finalization](_eventrecord_.finalization.md)
@@ -73,12 +73,27 @@ getencodedLength(): `number`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)*
*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L101)*
*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L101)*
*__description__*: The length of the value when encoded as a Uint8Array
**Returns:** `number`
___
<a id="index"></a>
## index
getindex(): `number`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)*
*Defined in [codec/EnumType.ts:108](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L108)*
*__description__*: The index of the metadata value
**Returns:** `number`
___
<a id="isnone"></a>
@@ -88,7 +103,7 @@ getisNone(): `boolean`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)*
*Defined in [codec/EnumType.ts:108](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L108)*
*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L115)*
*__description__*: Checks if the Enum points to a [Null](_null_.null.md) type
@@ -103,7 +118,7 @@ getisNull(): `boolean`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)*
*Defined in [codec/EnumType.ts:115](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L115)*
*Defined in [codec/EnumType.ts:122](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L122)*
*__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone)
@@ -118,7 +133,7 @@ gettype(): `string`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)*
*Defined in [codec/EnumType.ts:122](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L122)*
*Defined in [codec/EnumType.ts:129](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L129)*
*__description__*: The name of the type this enum value represents
@@ -133,7 +148,7 @@ getvalue(): [Codec](../interfaces/_types_.codec.md)
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)*
*Defined in [codec/EnumType.ts:129](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L129)*
*Defined in [codec/EnumType.ts:136](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L136)*
*__description__*: The value of the enum
@@ -153,7 +168,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)*
*Defined in [codec/EnumType.ts:136](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L136)*
*Defined in [codec/EnumType.ts:143](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L143)*
*__description__*: Compares the value of the input to see if there is a match
@@ -176,7 +191,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)*
*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L149)*
*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L156)*
*__description__*: Returns a hex string representation of the value
@@ -193,7 +208,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)*
*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L156)*
*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L163)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -208,7 +223,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)*
*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L163)*
*Defined in [codec/EnumType.ts:170](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L170)*
*__description__*: Returns the number representation for the value
@@ -225,7 +240,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)*
*Defined in [codec/EnumType.ts:170](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L170)*
*Defined in [codec/EnumType.ts:177](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L177)*
*__description__*: Returns the string representation of the value
@@ -242,7 +257,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)*
*Defined in [codec/EnumType.ts:178](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/EnumType.ts#L178)*
*Defined in [codec/EnumType.ts:185](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/EnumType.ts#L185)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_extrinsic_.extrinsic.html
+28 -28
View File
@@ -2160,7 +2160,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Extrinsic</strong>(value?: <em><code>ExtrinsicValue</code> | <a href="../modules/_types_.md#anyu8a">AnyU8a</a> | <a href="_method_.method.html">Method</a></em>): <a href="_extrinsic_.extrinsic.html">Extrinsic</a></p>
<p><em>Overrides <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L36" target="_blank">Extrinsic.ts:36</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L36" target="_blank">Extrinsic.ts:36</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2185,28 +2185,28 @@
<h2 id="type">Type</h2>
<p>getType(): <code>E</code></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#type">Type</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L142" target="_blank">codec/Struct.ts:142</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L142" target="_blank">codec/Struct.ts:142</a></em></p>
<p><em><strong>description</strong></em>: Returns the Type description to sthe structure</p>
<p><strong>Returns:</strong> <code>E</code></p>
<hr>
<p><a id="args"></a></p>
<h2 id="args">args</h2>
<p>getargs(): <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L76" target="_blank">Extrinsic.ts:76</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L76" target="_blank">Extrinsic.ts:76</a></em></p>
<p><em><strong>description</strong></em>: The arguments passed to for the call, exposes args so it is compatible with <a href="_method_.method.html">Method</a></p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<hr>
<p><a id="callindex"></a></p>
<h2 id="callindex">callIndex</h2>
<p>getcallIndex(): <code>Uint8Array</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L83" target="_blank">Extrinsic.ts:83</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L83" target="_blank">Extrinsic.ts:83</a></em></p>
<p><em><strong>description</strong></em>: The actual <code>[sectionIndex, methodIndex]</code> as used in the Method</p>
<p><strong>Returns:</strong> <code>Uint8Array</code></p>
<hr>
<p><a id="data"></a></p>
<h2 id="data">data</h2>
<p>getdata(): <code>Uint8Array</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L90" target="_blank">Extrinsic.ts:90</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L90" target="_blank">Extrinsic.ts:90</a></em></p>
<p><em><strong>description</strong></em>: The actual data for the Method</p>
<p><strong>Returns:</strong> <code>Uint8Array</code></p>
<hr>
@@ -2214,49 +2214,49 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Overrides <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L97" target="_blank">Extrinsic.ts:97</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L97" target="_blank">Extrinsic.ts:97</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="hash"></a></p>
<h2 id="hash">hash</h2>
<p>gethash(): <a href="_hash_.hash.html">Hash</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L106" target="_blank">Extrinsic.ts:106</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L106" target="_blank">Extrinsic.ts:106</a></em></p>
<p><em><strong>description</strong></em>: Convernience function, encodes the extrinsic and returns the actual hash</p>
<p><strong>Returns:</strong> <a href="_hash_.hash.html">Hash</a></p>
<hr>
<p><a id="issigned"></a></p>
<h2 id="issigned">isSigned</h2>
<p>getisSigned(): <code>boolean</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L115" target="_blank">Extrinsic.ts:115</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L115" target="_blank">Extrinsic.ts:115</a></em></p>
<p><em><strong>description</strong></em>: <code>true</code> id the extrinsic is signed</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
<p><a id="length"></a></p>
<h2 id="length">length</h2>
<p>getlength(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L122" target="_blank">Extrinsic.ts:122</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L122" target="_blank">Extrinsic.ts:122</a></em></p>
<p><em><strong>description</strong></em>: The length of the encoded value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="meta"></a></p>
<h2 id="meta">meta</h2>
<p>getmeta(): <a href="_metadata_modules_.functionmetadata.md">FunctionMetadata</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L129" target="_blank">Extrinsic.ts:129</a></em></p>
<p><em><strong>description</strong></em>: The <a href="_metadata_modules_.functionmetadata.md">FunctionMetadata</a> that describes the extrinsic</p>
<p><strong>Returns:</strong> <a href="_metadata_modules_.functionmetadata.md">FunctionMetadata</a></p>
<p>getmeta(): <a href="_metadata_v0_modules_.functionmetadata.md">FunctionMetadata</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L129" target="_blank">Extrinsic.ts:129</a></em></p>
<p><em><strong>description</strong></em>: The <a href="_metadata_v0_modules_.functionmetadata.md">FunctionMetadata</a> that describes the extrinsic</p>
<p><strong>Returns:</strong> <a href="_metadata_v0_modules_.functionmetadata.md">FunctionMetadata</a></p>
<hr>
<p><a id="method"></a></p>
<h2 id="method">method</h2>
<p>getmethod(): <a href="_method_.method.html">Method</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L136" target="_blank">Extrinsic.ts:136</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L136" target="_blank">Extrinsic.ts:136</a></em></p>
<p><em><strong>description</strong></em>: The <a href="_method_.method.html">Method</a> this extrinsic wraps</p>
<p><strong>Returns:</strong> <a href="_method_.method.html">Method</a></p>
<hr>
<p><a id="signature"></a></p>
<h2 id="signature">signature</h2>
<p>getsignature(): <a href="_extrinsicsignature_.extrinsicsignature.html">ExtrinsicSignature</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L143" target="_blank">Extrinsic.ts:143</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L143" target="_blank">Extrinsic.ts:143</a></em></p>
<p><em><strong>description</strong></em>: The <a href="_extrinsicsignature_.extrinsicsignature.html">ExtrinsicSignature</a></p>
<p><strong>Returns:</strong> <a href="_extrinsicsignature_.extrinsicsignature.html">ExtrinsicSignature</a></p>
<hr>
@@ -2264,7 +2264,7 @@
<p><a id="addsignature"></a></p>
<h2 id="addsignature">addSignature</h2>
<p>&#x25B8; <strong>addSignature</strong>(signer: <em><a href="_address_.address.html">Address</a> | <code>Uint8Array</code></em>, signature: <em><code>Uint8Array</code></em>, nonce: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>, era?: <em><a href="_codec_u8a_.u8a.html#uint8array">Uint8Array</a></em>): <a href="_extrinsic_.extrinsic.html">Extrinsic</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L150" target="_blank">Extrinsic.ts:150</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L150" target="_blank">Extrinsic.ts:150</a></em></p>
<p><em><strong>description</strong></em>: Add an <a href="_extrinsicsignature_.extrinsicsignature.html">ExtrinsicSignature</a> to the extrinsic (already generated)</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2301,7 +2301,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L158" target="_blank">codec/Struct.ts:158</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L158" target="_blank">codec/Struct.ts:158</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2325,7 +2325,7 @@
<p>&#x25B8; <strong>get</strong>(name: <em><code>keyof S</code></em>): <a href="../interfaces/_types_.codec.md">Codec</a> | <code>undefined</code></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#get">get</a></em></p>
<p><em>Overrides Map.get</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L166" target="_blank">codec/Struct.ts:166</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L166" target="_blank">codec/Struct.ts:166</a></em></p>
<p><em><strong>description</strong></em>: Returns a specific names entry in the structure</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2350,7 +2350,7 @@
<h2 id="getatindex">getAtIndex</h2>
<p>&#x25B8; <strong>getAtIndex</strong>(index: <em><code>number</code></em>): <a href="../interfaces/_types_.codec.md">Codec</a></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#getatindex">getAtIndex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L173" target="_blank">codec/Struct.ts:173</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L173" target="_blank">codec/Struct.ts:173</a></em></p>
<p><em><strong>description</strong></em>: Returns the values of a member at a specific index (Rather use get(name) for performance)</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2372,7 +2372,7 @@
<p><a id="sign"></a></p>
<h2 id="sign">sign</h2>
<p>&#x25B8; <strong>sign</strong>(signerPair: <em><code>KeyringPair</code></em>, nonce: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>, blockHash: <em><a href="../modules/_types_.md#anyu8a">AnyU8a</a></em>, era?: <em><a href="_codec_u8a_.u8a.html#uint8array">Uint8Array</a></em>): <a href="_extrinsic_.extrinsic.html">Extrinsic</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L159" target="_blank">Extrinsic.ts:159</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L159" target="_blank">Extrinsic.ts:159</a></em></p>
<p><em><strong>description</strong></em>: Sign the extrinsic with a specific keypair</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2407,7 +2407,7 @@
<h2 id="toarray">toArray</h2>
<p>&#x25B8; <strong>toArray</strong>(): <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#toarray">toArray</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L180" target="_blank">codec/Struct.ts:180</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L180" target="_blank">codec/Struct.ts:180</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to an standard JavaScript Array</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<hr>
@@ -2416,7 +2416,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Overrides <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L168" target="_blank">Extrinsic.ts:168</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L168" target="_blank">Extrinsic.ts:168</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2425,7 +2425,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Overrides <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L175" target="_blank">Extrinsic.ts:175</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L175" target="_blank">Extrinsic.ts:175</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2434,7 +2434,7 @@
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L208" target="_blank">codec/Struct.ts:208</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L208" target="_blank">codec/Struct.ts:208</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2443,7 +2443,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Overrides <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L183" target="_blank">Extrinsic.ts:183</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L183" target="_blank">Extrinsic.ts:183</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2469,7 +2469,7 @@
<p><a id="decodeextrinsic"></a></p>
<h2 id="static-decodeextrinsic"><code>&lt;Static&gt;</code> decodeExtrinsic</h2>
<p>&#x25B8; <strong>decodeExtrinsic</strong>(value: <em><code>ExtrinsicValue</code> | <a href="../modules/_types_.md#anyu8a">AnyU8a</a> | <a href="_method_.method.html">Method</a></em>): <code>ExtrinsicValue</code> | <code>Array</code>&lt;<code>number</code>&gt; | <code>Uint8Array</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L44" target="_blank">Extrinsic.ts:44</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L44" target="_blank">Extrinsic.ts:44</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2493,7 +2493,7 @@
<h2 id="static-with"><code>&lt;Static&gt;</code> with</h2>
<p>&#x25B8; <strong>with</strong>&lt;<code>S</code>&gt;(Types: <em><code>S</code></em>): <a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_struct_.struct.html">Struct</a>&lt;<code>S</code>&gt;&gt;</p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#with">with</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L122" target="_blank">codec/Struct.ts:122</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L122" target="_blank">codec/Struct.ts:122</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="s---constructordef">S : <a href="../modules/_types_.md#constructordef">ConstructorDef</a></h4>
<p><strong>Parameters:</strong></p>
@@ -2556,7 +2556,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.40","depth":1,"next":{"title":"hidden","level":"4.41","depth":1,"path":"types/classes/_extrinsicera_.extrinsicera.md","ref":"types/classes/_extrinsicera_.extrinsicera.md","articles":[]},"previous":{"title":"hidden","level":"4.39","depth":1,"path":"types/classes/_eventrecord_.phase.md","ref":"types/classes/_eventrecord_.phase.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_extrinsic_.extrinsic.md","mtime":"2019-01-25T10:38:54.148Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.40","depth":1,"next":{"title":"hidden","level":"4.41","depth":1,"path":"types/classes/_extrinsicera_.extrinsicera.md","ref":"types/classes/_extrinsicera_.extrinsicera.md","articles":[]},"previous":{"title":"hidden","level":"4.39","depth":1,"path":"types/classes/_eventrecord_.phase.md","ref":"types/classes/_eventrecord_.phase.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_extrinsic_.extrinsic.md","mtime":"2019-01-26T15:31:24.917Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_extrinsic_.extrinsic.md
+27 -27
View File
@@ -36,7 +36,7 @@ Can be:
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Extrinsic.ts:36](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L36)*
*Defined in [Extrinsic.ts:36](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L36)*
**Parameters:**
@@ -58,7 +58,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L142)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L142)*
*__description__*: Returns the Type description to sthe structure
@@ -71,7 +71,7 @@ ___
getargs(): `Array`<[Codec](../interfaces/_types_.codec.md)>
*Defined in [Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L76)*
*Defined in [Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L76)*
*__description__*: The arguments passed to for the call, exposes args so it is compatible with [Method](_method_.method.md)
@@ -84,7 +84,7 @@ ___
getcallIndex(): `Uint8Array`
*Defined in [Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L83)*
*Defined in [Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L83)*
*__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method
@@ -97,7 +97,7 @@ ___
getdata(): `Uint8Array`
*Defined in [Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L90)*
*Defined in [Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L90)*
*__description__*: The actual data for the Method
@@ -112,7 +112,7 @@ getencodedLength(): `number`
*Overrides [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
*Defined in [Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L97)*
*Defined in [Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L97)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -125,7 +125,7 @@ ___
gethash(): [Hash](_hash_.hash.md)
*Defined in [Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L106)*
*Defined in [Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L106)*
*__description__*: Convernience function, encodes the extrinsic and returns the actual hash
@@ -138,7 +138,7 @@ ___
getisSigned(): `boolean`
*Defined in [Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L115)*
*Defined in [Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L115)*
*__description__*: `true` id the extrinsic is signed
@@ -151,7 +151,7 @@ ___
getlength(): `number`
*Defined in [Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L122)*
*Defined in [Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L122)*
*__description__*: The length of the encoded value
@@ -162,13 +162,13 @@ ___
## meta
getmeta(): [FunctionMetadata](_metadata_modules_.functionmetadata.md)
getmeta(): [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md)
*Defined in [Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L129)*
*Defined in [Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L129)*
*__description__*: The [FunctionMetadata](_metadata_modules_.functionmetadata.md) that describes the extrinsic
*__description__*: The [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) that describes the extrinsic
**Returns:** [FunctionMetadata](_metadata_modules_.functionmetadata.md)
**Returns:** [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md)
___
<a id="method"></a>
@@ -177,7 +177,7 @@ ___
getmethod(): [Method](_method_.method.md)
*Defined in [Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L136)*
*Defined in [Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L136)*
*__description__*: The [Method](_method_.method.md) this extrinsic wraps
@@ -190,7 +190,7 @@ ___
getsignature(): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md)
*Defined in [Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L143)*
*Defined in [Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L143)*
*__description__*: The [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md)
@@ -206,7 +206,7 @@ ___
▸ **addSignature**(signer: *[Address](_address_.address.md) | `Uint8Array`*, signature: *`Uint8Array`*, nonce: *[AnyNumber](../modules/_types_.md#anynumber)*, era?: *[Uint8Array](_codec_u8a_.u8a.md#uint8array)*): [Extrinsic](_extrinsic_.extrinsic.md)
*Defined in [Extrinsic.ts:150](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L150)*
*Defined in [Extrinsic.ts:150](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L150)*
*__description__*: Add an [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) to the extrinsic (already generated)
@@ -232,7 +232,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L158)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L158)*
*__description__*: Compares the value of the input to see if there is a match
@@ -255,7 +255,7 @@ ___
*Overrides Map.get*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L166)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Returns a specific names entry in the structure
@@ -276,7 +276,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L173)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L173)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -295,7 +295,7 @@ ___
▸ **sign**(signerPair: *`KeyringPair`*, nonce: *[AnyNumber](../modules/_types_.md#anynumber)*, blockHash: *[AnyU8a](../modules/_types_.md#anyu8a)*, era?: *[Uint8Array](_codec_u8a_.u8a.md#uint8array)*): [Extrinsic](_extrinsic_.extrinsic.md)
*Defined in [Extrinsic.ts:159](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L159)*
*Defined in [Extrinsic.ts:159](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L159)*
*__description__*: Sign the extrinsic with a specific keypair
@@ -319,7 +319,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L180)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -336,7 +336,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
*Defined in [Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L168)*
*Defined in [Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L168)*
*__description__*: Returns a hex string representation of the value
@@ -353,7 +353,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [Extrinsic.ts:175](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L175)*
*Defined in [Extrinsic.ts:175](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L175)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -370,7 +370,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L208)*
*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L208)*
*__description__*: Returns the string representation of the value
@@ -387,7 +387,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [Extrinsic.ts:183](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L183)*
*Defined in [Extrinsic.ts:183](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L183)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -406,7 +406,7 @@ ___
▸ **decodeExtrinsic**(value: *`ExtrinsicValue` | [AnyU8a](../modules/_types_.md#anyu8a) | [Method](_method_.method.md)*): `ExtrinsicValue` | `Array`<`number`> | `Uint8Array`
*Defined in [Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/Extrinsic.ts#L44)*
*Defined in [Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/Extrinsic.ts#L44)*
**Parameters:**
@@ -425,7 +425,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L122)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L122)*
**Type parameters:**
docs/types/classes/_extrinsicera_.extrinsicera.html
+12 -12
View File
@@ -2151,7 +2151,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new ExtrinsicEra</strong>(value?: <em><a href="../modules/_types_.md#anyu8a">AnyU8a</a></em>): <a href="_extrinsicera_.extrinsicera.html">ExtrinsicEra</a></p>
<p><em>Overrides <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicEra.ts#L16" target="_blank">ExtrinsicEra.ts:16</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicEra.ts#L16" target="_blank">ExtrinsicEra.ts:16</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2174,7 +2174,7 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L36" target="_blank">codec/U8a.ts:36</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2182,7 +2182,7 @@
<h2 id="isempty">isEmpty</h2>
<p>getisEmpty(): <code>boolean</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#isempty">isEmpty</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em><strong>description</strong></em>: Returns true if the type wraps an empty/default all-0 value</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
@@ -2191,7 +2191,7 @@
<p>getlength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#length">length</a></em></p>
<p><em>Overrides Uint8Array.length</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50" target="_blank">codec/U8a.ts:50</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50" target="_blank">codec/U8a.ts:50</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2201,7 +2201,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L58" target="_blank">codec/U8a.ts:58</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L58" target="_blank">codec/U8a.ts:58</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2225,7 +2225,7 @@
<p>&#x25B8; <strong>subarray</strong>(begin: <em><code>number</code></em>, end?: <em><code>undefined</code> | <code>number</code></em>): <code>Uint8Array</code></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#subarray">subarray</a></em></p>
<p><em>Overrides Uint8Array.subarray</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73" target="_blank">codec/U8a.ts:73</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73" target="_blank">codec/U8a.ts:73</a></em></p>
<p><em><strong>description</strong></em>: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2257,7 +2257,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80" target="_blank">codec/U8a.ts:80</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80" target="_blank">codec/U8a.ts:80</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2266,7 +2266,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L87" target="_blank">codec/U8a.ts:87</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L87" target="_blank">codec/U8a.ts:87</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2276,7 +2276,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tostring">toString</a></em></p>
<p><em>Overrides Uint8Array.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L94" target="_blank">codec/U8a.ts:94</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L94" target="_blank">codec/U8a.ts:94</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2285,7 +2285,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_u8a_.u8a.html">U8a</a>.<a href="_codec_u8a_.u8a.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L102" target="_blank">codec/U8a.ts:102</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L102" target="_blank">codec/U8a.ts:102</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2311,7 +2311,7 @@
<p><a id="decodeextrinsicera"></a></p>
<h2 id="static-decodeextrinsicera"><code>&lt;Static&gt;</code> decodeExtrinsicEra</h2>
<p>&#x25B8; <strong>decodeExtrinsicEra</strong>(value?: <em><a href="../modules/_types_.md#anyu8a">AnyU8a</a></em>): <code>Uint8Array</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicEra.ts#L23" target="_blank">ExtrinsicEra.ts:23</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicEra.ts#L23" target="_blank">ExtrinsicEra.ts:23</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2372,7 +2372,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.41","depth":1,"next":{"title":"hidden","level":"4.42","depth":1,"path":"types/classes/_extrinsics_.extrinsics.md","ref":"types/classes/_extrinsics_.extrinsics.md","articles":[]},"previous":{"title":"hidden","level":"4.40","depth":1,"path":"types/classes/_extrinsic_.extrinsic.md","ref":"types/classes/_extrinsic_.extrinsic.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_extrinsicera_.extrinsicera.md","mtime":"2019-01-25T10:38:54.188Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.41","depth":1,"next":{"title":"hidden","level":"4.42","depth":1,"path":"types/classes/_extrinsics_.extrinsics.md","ref":"types/classes/_extrinsics_.extrinsics.md","articles":[]},"previous":{"title":"hidden","level":"4.40","depth":1,"path":"types/classes/_extrinsic_.extrinsic.md","ref":"types/classes/_extrinsic_.extrinsic.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_extrinsicera_.extrinsicera.md","mtime":"2019-01-26T15:31:24.949Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_extrinsicera_.extrinsicera.md
+11 -11
View File
@@ -27,7 +27,7 @@
*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)*
*Defined in [ExtrinsicEra.ts:16](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicEra.ts#L16)*
*Defined in [ExtrinsicEra.ts:16](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicEra.ts#L16)*
**Parameters:**
@@ -49,7 +49,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -64,7 +64,7 @@ getisEmpty(): `boolean`
*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L43)*
*__description__*: Returns true if the type wraps an empty/default all-0 value
@@ -81,7 +81,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L50)*
*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L50)*
*__description__*: The length of the value
@@ -101,7 +101,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L58)*
*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L58)*
*__description__*: Compares the value of the input to see if there is a match
@@ -124,7 +124,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L73)*
*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L73)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -148,7 +148,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L80)*
*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L80)*
*__description__*: Returns a hex string representation of the value
@@ -165,7 +165,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L87)*
*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L87)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -184,7 +184,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L94)*
*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L94)*
*__description__*: Returns the string representation of the value
@@ -201,7 +201,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/U8a.ts#L102)*
*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/U8a.ts#L102)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -220,7 +220,7 @@ ___
▸ **decodeExtrinsicEra**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): `Uint8Array`
*Defined in [ExtrinsicEra.ts:23](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicEra.ts#L23)*
*Defined in [ExtrinsicEra.ts:23](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicEra.ts#L23)*
**Parameters:**
docs/types/classes/_extrinsics_.extrinsics.html
+15 -15
View File
@@ -2154,7 +2154,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Extrinsics</strong>(Type: <em><a href="../modules/_types_.md#constructor">Constructor</a>&lt;<code>T</code>&gt;</em>, value?: <em><a href="_codec_vector_.vector.html">Vector</a>&lt;<code>any</code>&gt; | <code>Uint8Array</code> | <code>string</code> | <code>Array</code>&lt;<code>any</code>&gt;</em>): <a href="_extrinsics_.extrinsics.html">Extrinsics</a></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L22" target="_blank">codec/Vector.ts:22</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L22" target="_blank">codec/Vector.ts:22</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2187,14 +2187,14 @@
<h2 id="type">Type</h2>
<p>getType(): <code>string</code></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#type">Type</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L57" target="_blank">codec/Vector.ts:57</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L57" target="_blank">codec/Vector.ts:57</a></em></p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
<p><a id="encodedlength"></a></p>
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L64" target="_blank">codec/Vector.ts:64</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L64" target="_blank">codec/Vector.ts:64</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2203,7 +2203,7 @@
<p>getlength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#length">length</a></em></p>
<p><em>Overrides Array.length</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L73" target="_blank">codec/Vector.ts:73</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L73" target="_blank">codec/Vector.ts:73</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2213,7 +2213,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L81" target="_blank">codec/Vector.ts:81</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L81" target="_blank">codec/Vector.ts:81</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2237,7 +2237,7 @@
<p>&#x25B8; <strong>filter</strong>(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code>&lt;<code>T</code>&gt;</p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#filter">filter</a></em></p>
<p><em>Overrides Array.filter</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L146" target="_blank">codec/Vector.ts:146</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L146" target="_blank">codec/Vector.ts:146</a></em></p>
<p><em><strong>description</strong></em>: Filters the array with the callback</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2268,7 +2268,7 @@
<p>&#x25B8; <strong>map</strong>&lt;<code>U</code>&gt;(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code>&lt;<code>U</code>&gt;</p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#map">map</a></em></p>
<p><em>Overrides Array.map</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L155" target="_blank">codec/Vector.ts:155</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L155" target="_blank">codec/Vector.ts:155</a></em></p>
<p><em><strong>description</strong></em>: Maps the array with the callback</p>
<p><strong>Type parameters:</strong></p>
<h4 id="u">U</h4>
@@ -2300,7 +2300,7 @@
<h2 id="toarray">toArray</h2>
<p>&#x25B8; <strong>toArray</strong>(): <code>Array</code>&lt;<code>T</code>&gt;</p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#toarray">toArray</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L88" target="_blank">codec/Vector.ts:88</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L88" target="_blank">codec/Vector.ts:88</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to an standard JavaScript Array</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<code>T</code>&gt;</p>
<hr>
@@ -2309,7 +2309,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L95" target="_blank">codec/Vector.ts:95</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L95" target="_blank">codec/Vector.ts:95</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2318,7 +2318,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L102" target="_blank">codec/Vector.ts:102</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L102" target="_blank">codec/Vector.ts:102</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2328,7 +2328,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#tostring">toString</a></em></p>
<p><em>Overrides Array.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L111" target="_blank">codec/Vector.ts:111</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L111" target="_blank">codec/Vector.ts:111</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2337,7 +2337,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L124" target="_blank">codec/Vector.ts:124</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L124" target="_blank">codec/Vector.ts:124</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2364,7 +2364,7 @@
<h2 id="static-decodevector"><code>&lt;Static&gt;</code> decodeVector</h2>
<p>&#x25B8; <strong>decodeVector</strong>&lt;<code>T</code>&gt;(Type: <em><a href="../modules/_types_.md#constructor">Constructor</a>&lt;<code>T</code>&gt;</em>, value: <em><a href="_codec_vector_.vector.html">Vector</a>&lt;<code>any</code>&gt; | <code>Uint8Array</code> | <code>string</code> | <code>Array</code>&lt;<code>any</code>&gt;</em>): <code>Array</code>&lt;<code>T</code>&gt;</p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#decodevector">decodeVector</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L32" target="_blank">codec/Vector.ts:32</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L32" target="_blank">codec/Vector.ts:32</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="t---codec">T : <a href="../interfaces/_types_.codec.md">Codec</a></h4>
<p><strong>Parameters:</strong></p>
@@ -2395,7 +2395,7 @@
<h2 id="static-with"><code>&lt;Static&gt;</code> with</h2>
<p>&#x25B8; <strong>with</strong>&lt;<code>O</code>&gt;(Type: <em><a href="../modules/_types_.md#constructor">Constructor</a>&lt;<code>O</code>&gt;</em>): <a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_vector_.vector.html">Vector</a>&lt;<code>O</code>&gt;&gt;</p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#with">with</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L49" target="_blank">codec/Vector.ts:49</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L49" target="_blank">codec/Vector.ts:49</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="o---codec">O : <a href="../interfaces/_types_.codec.md">Codec</a></h4>
<p><strong>Parameters:</strong></p>
@@ -2458,7 +2458,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.42","depth":1,"next":{"title":"hidden","level":"4.43","depth":1,"path":"types/classes/_extrinsicsignature_.extrinsicsignature.md","ref":"types/classes/_extrinsicsignature_.extrinsicsignature.md","articles":[]},"previous":{"title":"hidden","level":"4.41","depth":1,"path":"types/classes/_extrinsicera_.extrinsicera.md","ref":"types/classes/_extrinsicera_.extrinsicera.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_extrinsics_.extrinsics.md","mtime":"2019-01-25T10:38:54.524Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.42","depth":1,"next":{"title":"hidden","level":"4.43","depth":1,"path":"types/classes/_extrinsicsignature_.extrinsicsignature.md","ref":"types/classes/_extrinsicsignature_.extrinsicsignature.md","articles":[]},"previous":{"title":"hidden","level":"4.41","depth":1,"path":"types/classes/_extrinsicera_.extrinsicera.md","ref":"types/classes/_extrinsicera_.extrinsicera.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_extrinsics_.extrinsics.md","mtime":"2019-01-26T15:31:25.521Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_extrinsics_.extrinsics.md
+14 -14
View File
@@ -31,7 +31,7 @@
*Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)*
*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L22)*
*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L22)*
**Parameters:**
@@ -54,7 +54,7 @@ getType(): `string`
*Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)*
*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L57)*
*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L57)*
**Returns:** `string`
@@ -67,7 +67,7 @@ getencodedLength(): `number`
*Inherited from [Vector](_codec_vector_.vector.md).[encodedLength](_codec_vector_.vector.md#encodedlength)*
*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L64)*
*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L64)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -84,7 +84,7 @@ getlength(): `number`
*Overrides Array.length*
*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L73)*
*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L73)*
*__description__*: The length of the value
@@ -104,7 +104,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[eq](_codec_vector_.vector.md#eq)*
*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L81)*
*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L81)*
*__description__*: Compares the value of the input to see if there is a match
@@ -127,7 +127,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Vector.ts:146](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L146)*
*Defined in [codec/Vector.ts:146](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L146)*
*__description__*: Filters the array with the callback
@@ -151,7 +151,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Vector.ts:155](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L155)*
*Defined in [codec/Vector.ts:155](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L155)*
*__description__*: Maps the array with the callback
@@ -176,7 +176,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)*
*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L88)*
*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L88)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -193,7 +193,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)*
*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L95)*
*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L95)*
*__description__*: Returns a hex string representation of the value
@@ -210,7 +210,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)*
*Defined in [codec/Vector.ts:102](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L102)*
*Defined in [codec/Vector.ts:102](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L102)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -229,7 +229,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Vector.ts:111](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L111)*
*Defined in [codec/Vector.ts:111](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L111)*
*__description__*: Returns the string representation of the value
@@ -246,7 +246,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)*
*Defined in [codec/Vector.ts:124](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L124)*
*Defined in [codec/Vector.ts:124](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L124)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -267,7 +267,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[decodeVector](_codec_vector_.vector.md#decodevector)*
*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L32)*
*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L32)*
**Type parameters:**
@@ -290,7 +290,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)*
*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L49)*
*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L49)*
**Type parameters:**
docs/types/classes/_extrinsicsignature_.extrinsicsignature.html
+22 -22
View File
@@ -2154,7 +2154,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new ExtrinsicSignature</strong>(value?: <em><a href="_codec_u8a_.u8a.html#uint8array">Uint8Array</a></em>): <a href="_extrinsicsignature_.extrinsicsignature.html">ExtrinsicSignature</a></p>
<p><em>Overrides <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L28" target="_blank">ExtrinsicSignature.ts:28</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L28" target="_blank">ExtrinsicSignature.ts:28</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2177,7 +2177,7 @@
<h2 id="type">Type</h2>
<p>getType(): <code>E</code></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#type">Type</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L142" target="_blank">codec/Struct.ts:142</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L142" target="_blank">codec/Struct.ts:142</a></em></p>
<p><em><strong>description</strong></em>: Returns the Type description to sthe structure</p>
<p><strong>Returns:</strong> <code>E</code></p>
<hr>
@@ -2185,49 +2185,49 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Overrides <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L65" target="_blank">ExtrinsicSignature.ts:65</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L65" target="_blank">ExtrinsicSignature.ts:65</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
<p><a id="era"></a></p>
<h2 id="era">era</h2>
<p>getera(): <a href="_extrinsicera_.extrinsicera.html">ExtrinsicEra</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L81" target="_blank">ExtrinsicSignature.ts:81</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L81" target="_blank">ExtrinsicSignature.ts:81</a></em></p>
<p><em><strong>description</strong></em>: The <a href="_extrinsicera_.extrinsicera.html">ExtrinsicEra</a> (mortal or immortal) this signature applies to</p>
<p><strong>Returns:</strong> <a href="_extrinsicera_.extrinsicera.html">ExtrinsicEra</a></p>
<hr>
<p><a id="issigned"></a></p>
<h2 id="issigned">isSigned</h2>
<p>getisSigned(): <code>boolean</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L74" target="_blank">ExtrinsicSignature.ts:74</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L74" target="_blank">ExtrinsicSignature.ts:74</a></em></p>
<p><em><strong>description</strong></em>: <code>true</code> if the signature is valid</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
<p><a id="nonce"></a></p>
<h2 id="nonce">nonce</h2>
<p>getnonce(): <a href="_nonce_.nonce.html">Nonce</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L88" target="_blank">ExtrinsicSignature.ts:88</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L88" target="_blank">ExtrinsicSignature.ts:88</a></em></p>
<p><em><strong>description</strong></em>: The <a href="_nonce_.nonce.html">Nonce</a> for the signature</p>
<p><strong>Returns:</strong> <a href="_nonce_.nonce.html">Nonce</a></p>
<hr>
<p><a id="signature"></a></p>
<h2 id="signature">signature</h2>
<p>getsignature(): <a href="_signature_.signature.html">Signature</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L95" target="_blank">ExtrinsicSignature.ts:95</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L95" target="_blank">ExtrinsicSignature.ts:95</a></em></p>
<p><em><strong>description</strong></em>: The actuall <a href="_signature_.signature.html">Signature</a> hash</p>
<p><strong>Returns:</strong> <a href="_signature_.signature.html">Signature</a></p>
<hr>
<p><a id="signer"></a></p>
<h2 id="signer">signer</h2>
<p>getsigner(): <a href="_address_.address.html">Address</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L102" target="_blank">ExtrinsicSignature.ts:102</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L102" target="_blank">ExtrinsicSignature.ts:102</a></em></p>
<p><em><strong>description</strong></em>: The <a href="_address_.address.html">Address</a> that signed</p>
<p><strong>Returns:</strong> <a href="_address_.address.html">Address</a></p>
<hr>
<p><a id="version"></a></p>
<h2 id="version">version</h2>
<p>getversion(): <code>number</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L109" target="_blank">ExtrinsicSignature.ts:109</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L109" target="_blank">ExtrinsicSignature.ts:109</a></em></p>
<p><em><strong>description</strong></em>: The encoded version for the signature</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2235,7 +2235,7 @@
<p><a id="addsignature"></a></p>
<h2 id="addsignature">addSignature</h2>
<p>&#x25B8; <strong>addSignature</strong>(<em>signer: *[Address](_address</em>.address.md) | <code>Uint8Array</code><em>, _signature: </em><code>Uint8Array</code><em>, _nonce: </em><a href="../modules/_types_.md#anynumber">AnyNumber</a><em>, _era?: </em><code>Uint8Array</code>*): <a href="_extrinsicsignature_.extrinsicsignature.html">ExtrinsicSignature</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L130" target="_blank">ExtrinsicSignature.ts:130</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L130" target="_blank">ExtrinsicSignature.ts:130</a></em></p>
<p><em><strong>description</strong></em>: Adds a raw signature</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2277,7 +2277,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L158" target="_blank">codec/Struct.ts:158</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L158" target="_blank">codec/Struct.ts:158</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2301,7 +2301,7 @@
<p>&#x25B8; <strong>get</strong>(name: <em><code>keyof S</code></em>): <a href="../interfaces/_types_.codec.md">Codec</a> | <code>undefined</code></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#get">get</a></em></p>
<p><em>Overrides Map.get</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L166" target="_blank">codec/Struct.ts:166</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L166" target="_blank">codec/Struct.ts:166</a></em></p>
<p><em><strong>description</strong></em>: Returns a specific names entry in the structure</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2326,7 +2326,7 @@
<h2 id="getatindex">getAtIndex</h2>
<p>&#x25B8; <strong>getAtIndex</strong>(index: <em><code>number</code></em>): <a href="../interfaces/_types_.codec.md">Codec</a></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#getatindex">getAtIndex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L173" target="_blank">codec/Struct.ts:173</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L173" target="_blank">codec/Struct.ts:173</a></em></p>
<p><em><strong>description</strong></em>: Returns the values of a member at a specific index (Rather use get(name) for performance)</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2348,7 +2348,7 @@
<p><a id="sign"></a></p>
<h2 id="sign">sign</h2>
<p>&#x25B8; <strong>sign</strong>(method: <em><a href="_method_.method.html">Method</a></em>, signerPair: <em><code>KeyringPair</code></em>, nonce: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>, blockHash: <em><a href="../modules/_types_.md#anyu8a">AnyU8a</a></em>, era?: <em><code>Uint8Array</code></em>): <a href="_extrinsicsignature_.extrinsicsignature.html">ExtrinsicSignature</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L142" target="_blank">ExtrinsicSignature.ts:142</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L142" target="_blank">ExtrinsicSignature.ts:142</a></em></p>
<p><em><strong>description</strong></em>: Generate a payload and pplies the signature from a keypair</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2393,7 +2393,7 @@
<h2 id="toarray">toArray</h2>
<p>&#x25B8; <strong>toArray</strong>(): <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#toarray">toArray</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L180" target="_blank">codec/Struct.ts:180</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L180" target="_blank">codec/Struct.ts:180</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to an standard JavaScript Array</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<a href="../interfaces/_types_.codec.md">Codec</a>&gt;</p>
<hr>
@@ -2402,7 +2402,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L187" target="_blank">codec/Struct.ts:187</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L187" target="_blank">codec/Struct.ts:187</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2411,7 +2411,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L194" target="_blank">codec/Struct.ts:194</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L194" target="_blank">codec/Struct.ts:194</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2420,7 +2420,7 @@
<p>&#x25B8; <strong>toString</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tostring">toString</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L208" target="_blank">codec/Struct.ts:208</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L208" target="_blank">codec/Struct.ts:208</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2429,7 +2429,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Overrides <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L159" target="_blank">ExtrinsicSignature.ts:159</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L159" target="_blank">ExtrinsicSignature.ts:159</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2455,7 +2455,7 @@
<p><a id="decodeextrinsicsignature"></a></p>
<h2 id="static-decodeextrinsicsignature"><code>&lt;Static&gt;</code> decodeExtrinsicSignature</h2>
<p>&#x25B8; <strong>decodeExtrinsicSignature</strong>(value?: <em><a href="_codec_u8a_.u8a.html#uint8array">Uint8Array</a></em>): <code>object</code> | <code>Uint8Array</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L45" target="_blank">ExtrinsicSignature.ts:45</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L45" target="_blank">ExtrinsicSignature.ts:45</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2477,7 +2477,7 @@
<h2 id="static-with"><code>&lt;Static&gt;</code> with</h2>
<p>&#x25B8; <strong>with</strong>&lt;<code>S</code>&gt;(Types: <em><code>S</code></em>): <a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_struct_.struct.html">Struct</a>&lt;<code>S</code>&gt;&gt;</p>
<p><em>Inherited from <a href="_codec_struct_.struct.html">Struct</a>.<a href="_codec_struct_.struct.html#with">with</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L122" target="_blank">codec/Struct.ts:122</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L122" target="_blank">codec/Struct.ts:122</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="s---constructordef">S : <a href="../modules/_types_.md#constructordef">ConstructorDef</a></h4>
<p><strong>Parameters:</strong></p>
@@ -2540,7 +2540,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.43","depth":1,"next":{"title":"hidden","level":"4.44","depth":1,"path":"types/classes/_extrinsicstatus_.broadcast.md","ref":"types/classes/_extrinsicstatus_.broadcast.md","articles":[]},"previous":{"title":"hidden","level":"4.42","depth":1,"path":"types/classes/_extrinsics_.extrinsics.md","ref":"types/classes/_extrinsics_.extrinsics.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_extrinsicsignature_.extrinsicsignature.md","mtime":"2019-01-25T10:38:54.240Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.43","depth":1,"next":{"title":"hidden","level":"4.44","depth":1,"path":"types/classes/_extrinsicstatus_.broadcast.md","ref":"types/classes/_extrinsicstatus_.broadcast.md","articles":[]},"previous":{"title":"hidden","level":"4.42","depth":1,"path":"types/classes/_extrinsics_.extrinsics.md","ref":"types/classes/_extrinsics_.extrinsics.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_extrinsicsignature_.extrinsicsignature.md","mtime":"2019-01-26T15:31:25.009Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_extrinsicsignature_.extrinsicsignature.md
+21 -21
View File
@@ -29,7 +29,7 @@
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [ExtrinsicSignature.ts:28](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L28)*
*Defined in [ExtrinsicSignature.ts:28](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L28)*
**Parameters:**
@@ -51,7 +51,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L142)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L142)*
*__description__*: Returns the Type description to sthe structure
@@ -66,7 +66,7 @@ getencodedLength(): `number`
*Overrides [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
*Defined in [ExtrinsicSignature.ts:65](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L65)*
*Defined in [ExtrinsicSignature.ts:65](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L65)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -79,7 +79,7 @@ ___
getera(): [ExtrinsicEra](_extrinsicera_.extrinsicera.md)
*Defined in [ExtrinsicSignature.ts:81](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L81)*
*Defined in [ExtrinsicSignature.ts:81](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L81)*
*__description__*: The [ExtrinsicEra](_extrinsicera_.extrinsicera.md) (mortal or immortal) this signature applies to
@@ -92,7 +92,7 @@ ___
getisSigned(): `boolean`
*Defined in [ExtrinsicSignature.ts:74](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L74)*
*Defined in [ExtrinsicSignature.ts:74](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L74)*
*__description__*: `true` if the signature is valid
@@ -105,7 +105,7 @@ ___
getnonce(): [Nonce](_nonce_.nonce.md)
*Defined in [ExtrinsicSignature.ts:88](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L88)*
*Defined in [ExtrinsicSignature.ts:88](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L88)*
*__description__*: The [Nonce](_nonce_.nonce.md) for the signature
@@ -118,7 +118,7 @@ ___
getsignature(): [Signature](_signature_.signature.md)
*Defined in [ExtrinsicSignature.ts:95](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L95)*
*Defined in [ExtrinsicSignature.ts:95](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L95)*
*__description__*: The actuall [Signature](_signature_.signature.md) hash
@@ -131,7 +131,7 @@ ___
getsigner(): [Address](_address_.address.md)
*Defined in [ExtrinsicSignature.ts:102](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L102)*
*Defined in [ExtrinsicSignature.ts:102](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L102)*
*__description__*: The [Address](_address_.address.md) that signed
@@ -144,7 +144,7 @@ ___
getversion(): `number`
*Defined in [ExtrinsicSignature.ts:109](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L109)*
*Defined in [ExtrinsicSignature.ts:109](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L109)*
*__description__*: The encoded version for the signature
@@ -160,7 +160,7 @@ ___
▸ **addSignature**(_signer: *[Address](_address_.address.md) | `Uint8Array`*, _signature: *`Uint8Array`*, _nonce: *[AnyNumber](../modules/_types_.md#anynumber)*, _era?: *`Uint8Array`*): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md)
*Defined in [ExtrinsicSignature.ts:130](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L130)*
*Defined in [ExtrinsicSignature.ts:130](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L130)*
*__description__*: Adds a raw signature
@@ -186,7 +186,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L158)*
*Defined in [codec/Struct.ts:158](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L158)*
*__description__*: Compares the value of the input to see if there is a match
@@ -209,7 +209,7 @@ ___
*Overrides Map.get*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L166)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Returns a specific names entry in the structure
@@ -230,7 +230,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L173)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L173)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -249,7 +249,7 @@ ___
▸ **sign**(method: *[Method](_method_.method.md)*, signerPair: *`KeyringPair`*, nonce: *[AnyNumber](../modules/_types_.md#anynumber)*, blockHash: *[AnyU8a](../modules/_types_.md#anyu8a)*, era?: *`Uint8Array`*): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md)
*Defined in [ExtrinsicSignature.ts:142](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L142)*
*Defined in [ExtrinsicSignature.ts:142](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L142)*
*__description__*: Generate a payload and pplies the signature from a keypair
@@ -274,7 +274,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L180)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -291,7 +291,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L187)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L187)*
*__description__*: Returns a hex string representation of the value
@@ -308,7 +308,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L194)*
*Defined in [codec/Struct.ts:194](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L194)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -325,7 +325,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L208)*
*Defined in [codec/Struct.ts:208](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L208)*
*__description__*: Returns the string representation of the value
@@ -342,7 +342,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [ExtrinsicSignature.ts:159](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L159)*
*Defined in [ExtrinsicSignature.ts:159](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L159)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -361,7 +361,7 @@ ___
▸ **decodeExtrinsicSignature**(value?: *[Uint8Array](_codec_u8a_.u8a.md#uint8array)*): `object` | `Uint8Array`
*Defined in [ExtrinsicSignature.ts:45](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/ExtrinsicSignature.ts#L45)*
*Defined in [ExtrinsicSignature.ts:45](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/ExtrinsicSignature.ts#L45)*
**Parameters:**
@@ -380,7 +380,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Struct.ts#L122)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Struct.ts#L122)*
**Type parameters:**
docs/types/classes/_extrinsicstatus_.broadcast.html
+15 -15
View File
@@ -2153,7 +2153,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Broadcast</strong>(Type: <em><a href="../modules/_types_.md#constructor">Constructor</a>&lt;<code>T</code>&gt;</em>, value?: <em><a href="_codec_vector_.vector.html">Vector</a>&lt;<code>any</code>&gt; | <code>Uint8Array</code> | <code>string</code> | <code>Array</code>&lt;<code>any</code>&gt;</em>): <a href="_extrinsicstatus_.broadcast.html">Broadcast</a></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L22" target="_blank">codec/Vector.ts:22</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L22" target="_blank">codec/Vector.ts:22</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2186,14 +2186,14 @@
<h2 id="type">Type</h2>
<p>getType(): <code>string</code></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#type">Type</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L57" target="_blank">codec/Vector.ts:57</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L57" target="_blank">codec/Vector.ts:57</a></em></p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
<p><a id="encodedlength"></a></p>
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#encodedlength">encodedLength</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L64" target="_blank">codec/Vector.ts:64</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L64" target="_blank">codec/Vector.ts:64</a></em></p>
<p><em><strong>description</strong></em>: The length of the value when encoded as a Uint8Array</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2202,7 +2202,7 @@
<p>getlength(): <code>number</code></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#length">length</a></em></p>
<p><em>Overrides Array.length</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L73" target="_blank">codec/Vector.ts:73</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L73" target="_blank">codec/Vector.ts:73</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2212,7 +2212,7 @@
<p>&#x25B8; <strong>eq</strong>(other?: <em><code>any</code></em>): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#eq">eq</a></em></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#eq">eq</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L81" target="_blank">codec/Vector.ts:81</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L81" target="_blank">codec/Vector.ts:81</a></em></p>
<p><em><strong>description</strong></em>: Compares the value of the input to see if there is a match</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2236,7 +2236,7 @@
<p>&#x25B8; <strong>filter</strong>(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code>&lt;<code>T</code>&gt;</p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#filter">filter</a></em></p>
<p><em>Overrides Array.filter</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L146" target="_blank">codec/Vector.ts:146</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L146" target="_blank">codec/Vector.ts:146</a></em></p>
<p><em><strong>description</strong></em>: Filters the array with the callback</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2267,7 +2267,7 @@
<p>&#x25B8; <strong>map</strong>&lt;<code>U</code>&gt;(callbackfn: <em><code>function</code></em>, thisArg?: <em><code>any</code></em>): <code>Array</code>&lt;<code>U</code>&gt;</p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#map">map</a></em></p>
<p><em>Overrides Array.map</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L155" target="_blank">codec/Vector.ts:155</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L155" target="_blank">codec/Vector.ts:155</a></em></p>
<p><em><strong>description</strong></em>: Maps the array with the callback</p>
<p><strong>Type parameters:</strong></p>
<h4 id="u">U</h4>
@@ -2299,7 +2299,7 @@
<h2 id="toarray">toArray</h2>
<p>&#x25B8; <strong>toArray</strong>(): <code>Array</code>&lt;<code>T</code>&gt;</p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#toarray">toArray</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L88" target="_blank">codec/Vector.ts:88</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L88" target="_blank">codec/Vector.ts:88</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to an standard JavaScript Array</p>
<p><strong>Returns:</strong> <code>Array</code>&lt;<code>T</code>&gt;</p>
<hr>
@@ -2308,7 +2308,7 @@
<p>&#x25B8; <strong>toHex</strong>(): <code>string</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tohex">toHex</a></em></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L95" target="_blank">codec/Vector.ts:95</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L95" target="_blank">codec/Vector.ts:95</a></em></p>
<p><em><strong>description</strong></em>: Returns a hex string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2317,7 +2317,7 @@
<p>&#x25B8; <strong>toJSON</strong>(): <code>any</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tojson">toJSON</a></em></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#tojson">toJSON</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L102" target="_blank">codec/Vector.ts:102</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L102" target="_blank">codec/Vector.ts:102</a></em></p>
<p><em><strong>description</strong></em>: Converts the Object to JSON, typically used for RPC transfers</p>
<p><strong>Returns:</strong> <code>any</code></p>
<hr>
@@ -2327,7 +2327,7 @@
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tostring">toString</a></em></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#tostring">toString</a></em></p>
<p><em>Overrides Array.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L111" target="_blank">codec/Vector.ts:111</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L111" target="_blank">codec/Vector.ts:111</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2336,7 +2336,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em><code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.codec.md">Codec</a>.<a href="../interfaces/_types_.codec.md#tou8a">toU8a</a></em></p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L124" target="_blank">codec/Vector.ts:124</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L124" target="_blank">codec/Vector.ts:124</a></em></p>
<p><em><strong>description</strong></em>: Encodes the value as a Uint8Array as per the parity-codec specifications</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2363,7 +2363,7 @@
<h2 id="static-decodevector"><code>&lt;Static&gt;</code> decodeVector</h2>
<p>&#x25B8; <strong>decodeVector</strong>&lt;<code>T</code>&gt;(Type: <em><a href="../modules/_types_.md#constructor">Constructor</a>&lt;<code>T</code>&gt;</em>, value: <em><a href="_codec_vector_.vector.html">Vector</a>&lt;<code>any</code>&gt; | <code>Uint8Array</code> | <code>string</code> | <code>Array</code>&lt;<code>any</code>&gt;</em>): <code>Array</code>&lt;<code>T</code>&gt;</p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#decodevector">decodeVector</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L32" target="_blank">codec/Vector.ts:32</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L32" target="_blank">codec/Vector.ts:32</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="t---codec">T : <a href="../interfaces/_types_.codec.md">Codec</a></h4>
<p><strong>Parameters:</strong></p>
@@ -2394,7 +2394,7 @@
<h2 id="static-with"><code>&lt;Static&gt;</code> with</h2>
<p>&#x25B8; <strong>with</strong>&lt;<code>O</code>&gt;(Type: <em><a href="../modules/_types_.md#constructor">Constructor</a>&lt;<code>O</code>&gt;</em>): <a href="../modules/_types_.md#constructor">Constructor</a>&lt;<a href="_codec_vector_.vector.html">Vector</a>&lt;<code>O</code>&gt;&gt;</p>
<p><em>Inherited from <a href="_codec_vector_.vector.html">Vector</a>.<a href="_codec_vector_.vector.html#with">with</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/98ea1f9/packages/types/src/codec/Vector.ts#L49" target="_blank">codec/Vector.ts:49</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/fd93fbc/packages/types/src/codec/Vector.ts#L49" target="_blank">codec/Vector.ts:49</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="o---codec">O : <a href="../interfaces/_types_.codec.md">Codec</a></h4>
<p><strong>Parameters:</strong></p>
@@ -2457,7 +2457,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.44","depth":1,"next":{"title":"hidden","level":"4.45","depth":1,"path":"types/classes/_extrinsicstatus_.dropped.md","ref":"types/classes/_extrinsicstatus_.dropped.md","articles":[]},"previous":{"title":"hidden","level":"4.43","depth":1,"path":"types/classes/_extrinsicsignature_.extrinsicsignature.md","ref":"types/classes/_extrinsicsignature_.extrinsicsignature.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_extrinsicstatus_.broadcast.md","mtime":"2019-01-25T10:38:54.284Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-25T10:39:32.326Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"hidden","level":"4.44","depth":1,"next":{"title":"hidden","level":"4.45","depth":1,"path":"types/classes/_extrinsicstatus_.dropped.md","ref":"types/classes/_extrinsicstatus_.dropped.md","articles":[]},"previous":{"title":"hidden","level":"4.43","depth":1,"path":"types/classes/_extrinsicsignature_.extrinsicsignature.md","ref":"types/classes/_extrinsicsignature_.extrinsicsignature.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"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},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":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":"types/classes/_extrinsicstatus_.broadcast.md","mtime":"2019-01-26T15:31:25.045Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-26T15:32:05.118Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>

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