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

[CI Skip] 0.35.6

Browse Source
This commit is contained in:
Travis CI
2018-12-21 12:44:10 +00:00
parent 1e880757e4
commit fe605bff90
346 changed files with 3408 additions and 3408 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/types/classes/_accountid_.accountid.html
+11 -11
View File
@@ -1977,7 +1977,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/db95340/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/1e88075/packages/types/src/AccountId.ts#L19" target="_blank">AccountId.ts:19</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2037,7 +2037,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/db95340/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/1e88075/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>
@@ -2046,7 +2046,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/db95340/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/1e88075/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2062,7 +2062,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/db95340/packages/types/src/codec/U8aFixed.ts#L39" target="_blank">codec/U8aFixed.ts:39</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8aFixed.ts#L39" target="_blank">codec/U8aFixed.ts:39</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>
@@ -2729,7 +2729,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/db95340/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</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>
@@ -2760,7 +2760,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/db95340/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</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>
@@ -2769,7 +2769,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/db95340/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/1e88075/packages/types/src/AccountId.ts#L46" target="_blank">AccountId.ts:46</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>
@@ -2786,7 +2786,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/db95340/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/1e88075/packages/types/src/AccountId.ts#L53" target="_blank">AccountId.ts:53</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>
@@ -2794,7 +2794,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>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/db95340/packages/types/src/codec/U8a.ts#L82" target="_blank">codec/U8a.ts:82</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L82" target="_blank">codec/U8a.ts:82</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>
@@ -2826,7 +2826,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/db95340/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/1e88075/packages/types/src/AccountId.ts#L27" target="_blank">AccountId.ts:27</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2887,7 +2887,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":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/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":"2018-12-21T12:22:03.720Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"Display system events","level":"3.1.6","depth":2,"path":"examples/promise/08_system_events/README.md","ref":"examples/promise/08_system_events/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":"2018-12-21T12:42:31.438Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_accountid_.accountid.md
+10 -10
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/db95340/packages/types/src/AccountId.ts#L19)*
*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountId.ts#L19)*
**Parameters:**
@@ -117,7 +117,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -134,7 +134,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L43)*
*__description__*: The length of the value
@@ -165,7 +165,7 @@ ___
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8aFixed.ts#L39)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8aFixed.ts#L39)*
*__description__*: Returns the number of bits in the value
@@ -691,7 +691,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -715,7 +715,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L60)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60)*
*__description__*: Returns a hex string representation of the value
@@ -732,7 +732,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/AccountId.ts#L46)*
*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountId.ts#L46)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -764,7 +764,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/AccountId.ts#L53)*
*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountId.ts#L53)*
*__description__*: Returns the string representation of the value
@@ -779,7 +779,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L82)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L82)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -813,7 +813,7 @@ ___
▸ **encode**(value: *`Uint8Array`*): `string`
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/AccountId.ts#L27)*
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountId.ts#L27)*
**Parameters:**
docs/types/classes/_accountindex_.accountindex.html
+14 -14
View File
@@ -1974,7 +1974,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/db95340/packages/types/src/AccountIndex.ts#L29" target="_blank">AccountIndex.ts:29</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountIndex.ts#L29" target="_blank">AccountIndex.ts:29</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -1999,7 +1999,7 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from AbstractInt.encodedLength</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L56" target="_blank">codec/AbstractInt.ts:56</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L56" target="_blank">codec/AbstractInt.ts:56</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>
@@ -2132,7 +2132,7 @@
<p>&#x25B8; <strong>bitLength</strong>(): <a href="../modules/_codec_abstractint_.md#uintbitlength">UIntBitLength</a></p>
<p><em>Inherited from AbstractInt.bitLength</em></p>
<p><em>Overrides BN.bitLength</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L63" target="_blank">codec/AbstractInt.ts:63</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L63" target="_blank">codec/AbstractInt.ts:63</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>
@@ -3510,7 +3510,7 @@
<h2 id="tobn">toBn</h2>
<p>&#x25B8; <strong>toBn</strong>(): <code>BN</code></p>
<p><em>Overrides AbstractInt.toBn</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/AccountIndex.ts#L92" target="_blank">AccountIndex.ts:92</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountIndex.ts#L92" target="_blank">AccountIndex.ts:92</a></em></p>
<p><em><strong>description</strong></em>: Returns the BN representation of the AccountIndex</p>
<p><strong>Returns:</strong> <code>BN</code></p>
<hr>
@@ -3546,7 +3546,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_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tohex">toHex</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/AccountIndex.ts#L99" target="_blank">AccountIndex.ts:99</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountIndex.ts#L99" target="_blank">AccountIndex.ts:99</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>
@@ -3555,7 +3555,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/db95340/packages/types/src/AccountIndex.ts#L108" target="_blank">AccountIndex.ts:108</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountIndex.ts#L108" target="_blank">AccountIndex.ts:108</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>
@@ -3595,7 +3595,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/db95340/packages/types/src/AccountIndex.ts#L115" target="_blank">AccountIndex.ts:115</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountIndex.ts#L115" target="_blank">AccountIndex.ts:115</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>
@@ -3627,7 +3627,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em> <code>undefined</code> | <code>false</code> | <code>true</code></em>, isStorageKey?: <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_uint_.uint.html">UInt</a>.<a href="_codec_uint_.uint.html#tou8a">toU8a</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/AccountIndex.ts#L126" target="_blank">AccountIndex.ts:126</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountIndex.ts#L126" target="_blank">AccountIndex.ts:126</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>
@@ -3848,7 +3848,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/db95340/packages/types/src/AccountIndex.ts#L52" target="_blank">AccountIndex.ts:52</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountIndex.ts#L52" target="_blank">AccountIndex.ts:52</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -3870,7 +3870,7 @@
<h2 id="static-decodeabstracint"><code>&lt;Static&gt;</code> decodeAbstracInt</h2>
<p>&#x25B8; <strong>decodeAbstracInt</strong>(value: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>, bitLength: <em><a href="../modules/_codec_abstractint_.md#uintbitlength">UIntBitLength</a></em>, isNegative: <em><code>boolean</code></em>): <code>string</code></p>
<p><em>Inherited from AbstractInt.decodeAbstracInt</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L37" target="_blank">codec/AbstractInt.ts:37</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L37" target="_blank">codec/AbstractInt.ts:37</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -3899,7 +3899,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/db95340/packages/types/src/AccountIndex.ts#L36" target="_blank">AccountIndex.ts:36</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountIndex.ts#L36" target="_blank">AccountIndex.ts:36</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -4020,7 +4020,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/db95340/packages/types/src/AccountIndex.ts#L66" target="_blank">AccountIndex.ts:66</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountIndex.ts#L66" target="_blank">AccountIndex.ts:66</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -4064,7 +4064,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/db95340/packages/types/src/AccountIndex.ts#L80" target="_blank">AccountIndex.ts:80</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountIndex.ts#L80" target="_blank">AccountIndex.ts:80</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -4125,7 +4125,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":"2018-12-21T12:22:03.992Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:31.714Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_accountindex_.accountindex.md
+13 -13
View File
@@ -24,7 +24,7 @@
*Overrides [U32](_u32_.u32.md).[constructor](_u32_.u32.md#constructor)*
*Defined in [AccountIndex.ts:29](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/AccountIndex.ts#L29)*
*Defined in [AccountIndex.ts:29](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountIndex.ts#L29)*
**Parameters:**
@@ -46,7 +46,7 @@ getencodedLength(): `number`
*Inherited from AbstractInt.encodedLength*
*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L56)*
*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L56)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -186,7 +186,7 @@ ___
*Overrides BN.bitLength*
*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L63)*
*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L63)*
*__description__*: Returns the number of bits in the value
@@ -1521,7 +1521,7 @@ ___
*Overrides AbstractInt.toBn*
*Defined in [AccountIndex.ts:92](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/AccountIndex.ts#L92)*
*Defined in [AccountIndex.ts:92](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountIndex.ts#L92)*
*__description__*: Returns the BN representation of the AccountIndex
@@ -1560,7 +1560,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)*
*Defined in [AccountIndex.ts:99](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/AccountIndex.ts#L99)*
*Defined in [AccountIndex.ts:99](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountIndex.ts#L99)*
*__description__*: Returns a hex string representation of the value
@@ -1577,7 +1577,7 @@ ___
*Overrides AbstractInt.toJSON*
*Defined in [AccountIndex.ts:108](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/AccountIndex.ts#L108)*
*Defined in [AccountIndex.ts:108](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountIndex.ts#L108)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1630,7 +1630,7 @@ ___
*Overrides AbstractInt.toString*
*Defined in [AccountIndex.ts:115](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/AccountIndex.ts#L115)*
*Defined in [AccountIndex.ts:115](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountIndex.ts#L115)*
*__description__*: Returns the string representation of the value
@@ -1668,7 +1668,7 @@ ___
*Overrides [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)*
*Defined in [AccountIndex.ts:126](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/AccountIndex.ts#L126)*
*Defined in [AccountIndex.ts:126](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountIndex.ts#L126)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1871,7 +1871,7 @@ ___
▸ **calcLength**(_value: * `BN` &#124; `number`*): `number`
*Defined in [AccountIndex.ts:52](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/AccountIndex.ts#L52)*
*Defined in [AccountIndex.ts:52](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountIndex.ts#L52)*
**Parameters:**
@@ -1890,7 +1890,7 @@ ___
*Inherited from AbstractInt.decodeAbstracInt*
*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L37)*
*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L37)*
**Parameters:**
@@ -1909,7 +1909,7 @@ ___
▸ **decodeAccountIndex**(value: *[AnyNumber](../modules/_types_.md#anynumber)*): `BN` &#124; `Uint8Array` &#124; `number` &#124; `string`
*Defined in [AccountIndex.ts:36](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/AccountIndex.ts#L36)*
*Defined in [AccountIndex.ts:36](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountIndex.ts#L36)*
**Parameters:**
@@ -2012,7 +2012,7 @@ ___
▸ **readLength**(input: *`Uint8Array`*): [`number`, `number`]
*Defined in [AccountIndex.ts:66](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/AccountIndex.ts#L66)*
*Defined in [AccountIndex.ts:66](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountIndex.ts#L66)*
**Parameters:**
@@ -2050,7 +2050,7 @@ ___
▸ **writeLength**(input: *`Uint8Array`*): `Uint8Array`
*Defined in [AccountIndex.ts:80](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/AccountIndex.ts#L80)*
*Defined in [AccountIndex.ts:80](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountIndex.ts#L80)*
**Parameters:**
docs/types/classes/_address_.address.html
+9 -9
View File
@@ -1970,7 +1970,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/db95340/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/1e88075/packages/types/src/Address.ts#L25" target="_blank">Address.ts:25</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -1994,14 +1994,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/db95340/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/1e88075/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/db95340/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/1e88075/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>
@@ -2009,28 +2009,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/db95340/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/1e88075/packages/types/src/Address.ts#L90" target="_blank">Address.ts:90</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/db95340/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/1e88075/packages/types/src/Address.ts#L97" target="_blank">Address.ts:97</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/db95340/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/1e88075/packages/types/src/Address.ts#L104" target="_blank">Address.ts:104</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/db95340/packages/types/src/Address.ts#L112" target="_blank">Address.ts:112</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Address.ts#L112" target="_blank">Address.ts:112</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>
@@ -2054,7 +2054,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/db95340/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/1e88075/packages/types/src/Address.ts#L32" target="_blank">Address.ts:32</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2115,7 +2115,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":"2018-12-21T12:22:04.016Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:31.734Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_address_.address.md
+8 -8
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/db95340/packages/types/src/Address.ts#L25)*
*Defined in [Address.ts:25](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/Address.ts#L67)*
*Defined in [Address.ts:67](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/Address.ts#L81)*
*Defined in [Address.ts:81](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Address.ts#L81)*
*__description__*: The length of the raw value, either AccountIndex or AccountId
@@ -69,7 +69,7 @@ ___
▸ **toHex**(): `string`
*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Address.ts#L90)*
*Defined in [Address.ts:90](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Address.ts#L90)*
*__description__*: Returns a hex string representation of the value
@@ -82,7 +82,7 @@ ___
▸ **toJSON**(): `any`
*Defined in [Address.ts:97](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Address.ts#L97)*
*Defined in [Address.ts:97](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Address.ts#L97)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -95,7 +95,7 @@ ___
▸ **toString**(): `string`
*Defined in [Address.ts:104](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Address.ts#L104)*
*Defined in [Address.ts:104](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Address.ts#L104)*
*__description__*: Returns the string representation of the value
@@ -108,7 +108,7 @@ ___
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Defined in [Address.ts:112](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Address.ts#L112)*
*Defined in [Address.ts:112](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Address.ts#L112)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -127,7 +127,7 @@ ___
▸ **decodeAddress**(value: *`AnyAddress`*): [AccountId](_accountid_.accountid.md) &#124; [AccountIndex](_accountindex_.accountindex.md)
*Defined in [Address.ts:32](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Address.ts#L32)*
*Defined in [Address.ts:32](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Address.ts#L32)*
**Parameters:**
docs/types/classes/_attestedcandidate_.attestedcandidate.md
+11 -11
View File
@@ -29,7 +29,7 @@
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [AttestedCandidate.ts:74](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/AttestedCandidate.ts#L74)*
*Defined in [AttestedCandidate.ts:74](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AttestedCandidate.ts#L74)*
**Parameters:**
@@ -76,7 +76,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L142)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L142)*
*__description__*: Returns the Type description to sthe structure
@@ -91,7 +91,7 @@ getencodedLength(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L149)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L149)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -193,7 +193,7 @@ ___
*Overrides Map.get*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L159)*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L159)*
*__description__*: Returns a specific names entry in the structure
@@ -214,7 +214,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L166)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -289,7 +289,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L173)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L173)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -306,7 +306,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L180)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Returns a hex string representation of the value
@@ -323,7 +323,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L187)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L187)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -340,7 +340,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L201)*
*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L201)*
*__description__*: Returns the string representation of the value
@@ -355,7 +355,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L209)*
*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L209)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -391,7 +391,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L122)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L122)*
**Type parameters:**
docs/types/classes/_attestedcandidate_.availabilityvote.md
+11 -11
View File
@@ -25,7 +25,7 @@
*Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [codec/Tuple.ts:20](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L20)*
*Defined in [codec/Tuple.ts:20](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L20)*
**Parameters:**
@@ -64,7 +64,7 @@ getTypes(): `Array`<`string`>
*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)*
*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L65)*
*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L65)*
*__description__*: The types definition of the tuple
@@ -79,7 +79,7 @@ getencodedLength(): `number`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)*
*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L56)*
*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L56)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -249,7 +249,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L121)*
*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L121)*
*__description__*: Filters the array with the callback
@@ -669,7 +669,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L130)*
*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L130)*
*__description__*: Maps the array with the callback
@@ -977,7 +977,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L72)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L72)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -994,7 +994,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)*
*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L79)*
*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L79)*
*__description__*: Returns a hex string representation of the value
@@ -1011,7 +1011,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L86)*
*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L86)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1045,7 +1045,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L95)*
*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L95)*
*__description__*: Returns the string representation of the value
@@ -1060,7 +1060,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)*
*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L104)*
*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L104)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1117,7 +1117,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L43)*
*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L43)*
**Type parameters:**
docs/types/classes/_attestedcandidate_.balanceupload.md
+11 -11
View File
@@ -25,7 +25,7 @@
*Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [codec/Tuple.ts:20](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L20)*
*Defined in [codec/Tuple.ts:20](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L20)*
**Parameters:**
@@ -64,7 +64,7 @@ getTypes(): `Array`<`string`>
*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)*
*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L65)*
*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L65)*
*__description__*: The types definition of the tuple
@@ -79,7 +79,7 @@ getencodedLength(): `number`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)*
*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L56)*
*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L56)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -249,7 +249,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L121)*
*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L121)*
*__description__*: Filters the array with the callback
@@ -669,7 +669,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L130)*
*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L130)*
*__description__*: Maps the array with the callback
@@ -977,7 +977,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L72)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L72)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -994,7 +994,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)*
*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L79)*
*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L79)*
*__description__*: Returns a hex string representation of the value
@@ -1011,7 +1011,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L86)*
*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L86)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1045,7 +1045,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L95)*
*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L95)*
*__description__*: Returns the string representation of the value
@@ -1060,7 +1060,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)*
*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L104)*
*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L104)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1117,7 +1117,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L43)*
*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L43)*
**Type parameters:**
docs/types/classes/_attestedcandidate_.candidatereceipt.md
+11 -11
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/db95340/packages/types/src/AttestedCandidate.ts#L30)*
*Defined in [AttestedCandidate.ts:30](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AttestedCandidate.ts#L30)*
**Parameters:**
@@ -72,7 +72,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L142)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L142)*
*__description__*: Returns the Type description to sthe structure
@@ -87,7 +87,7 @@ getencodedLength(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L149)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L149)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -189,7 +189,7 @@ ___
*Overrides Map.get*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L159)*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L159)*
*__description__*: Returns a specific names entry in the structure
@@ -210,7 +210,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L166)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -285,7 +285,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L173)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L173)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -302,7 +302,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L180)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Returns a hex string representation of the value
@@ -319,7 +319,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L187)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L187)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -336,7 +336,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L201)*
*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L201)*
*__description__*: Returns the string representation of the value
@@ -351,7 +351,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L209)*
*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L209)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -387,7 +387,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L122)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L122)*
**Type parameters:**
docs/types/classes/_attestedcandidate_.candidatesignature.md
+9 -9
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/db95340/packages/types/src/H512.ts#L14)*
*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/H512.ts#L14)*
**Parameters:**
@@ -117,7 +117,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -134,7 +134,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L43)*
*__description__*: The length of the value
@@ -165,7 +165,7 @@ ___
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8aFixed.ts#L39)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8aFixed.ts#L39)*
*__description__*: Returns the number of bits in the value
@@ -691,7 +691,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -715,7 +715,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L60)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60)*
*__description__*: Returns a hex string representation of the value
@@ -732,7 +732,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L67)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L67)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -766,7 +766,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L74)*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L74)*
*__description__*: Returns the string representation of the value
@@ -781,7 +781,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L82)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L82)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_attestedcandidate_.egressqueueroot.md
+11 -11
View File
@@ -25,7 +25,7 @@
*Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [codec/Tuple.ts:20](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L20)*
*Defined in [codec/Tuple.ts:20](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L20)*
**Parameters:**
@@ -64,7 +64,7 @@ getTypes(): `Array`<`string`>
*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)*
*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L65)*
*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L65)*
*__description__*: The types definition of the tuple
@@ -79,7 +79,7 @@ getencodedLength(): `number`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)*
*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L56)*
*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L56)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -249,7 +249,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L121)*
*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L121)*
*__description__*: Filters the array with the callback
@@ -669,7 +669,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L130)*
*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L130)*
*__description__*: Maps the array with the callback
@@ -977,7 +977,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L72)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L72)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -994,7 +994,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)*
*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L79)*
*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L79)*
*__description__*: Returns a hex string representation of the value
@@ -1011,7 +1011,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L86)*
*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L86)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1045,7 +1045,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L95)*
*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L95)*
*__description__*: Returns the string representation of the value
@@ -1060,7 +1060,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)*
*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L104)*
*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L104)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1117,7 +1117,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L43)*
*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L43)*
**Type parameters:**
docs/types/classes/_attestedcandidate_.explicitcandidatesignature.md
+9 -9
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/db95340/packages/types/src/H512.ts#L14)*
*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/H512.ts#L14)*
**Parameters:**
@@ -113,7 +113,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -130,7 +130,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L43)*
*__description__*: The length of the value
@@ -161,7 +161,7 @@ ___
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8aFixed.ts#L39)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8aFixed.ts#L39)*
*__description__*: Returns the number of bits in the value
@@ -687,7 +687,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -711,7 +711,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L60)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60)*
*__description__*: Returns a hex string representation of the value
@@ -728,7 +728,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L67)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L67)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -762,7 +762,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L74)*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L74)*
*__description__*: Returns the string representation of the value
@@ -777,7 +777,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L82)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L82)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_attestedcandidate_.headdata.md
+8 -8
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/db95340/packages/types/src/Bytes.ts#L18)*
*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bytes.ts#L18)*
**Parameters:**
@@ -115,7 +115,7 @@ getencodedLength(): `number`
*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Bytes.ts#L64)*
*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bytes.ts#L64)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -132,7 +132,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L43)*
*__description__*: The length of the value
@@ -674,7 +674,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -698,7 +698,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L60)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60)*
*__description__*: Returns a hex string representation of the value
@@ -715,7 +715,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L67)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L67)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -749,7 +749,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L74)*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L74)*
*__description__*: Returns the string representation of the value
@@ -766,7 +766,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Bytes.ts#L72)*
*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bytes.ts#L72)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_attestedcandidate_.implicitcandidatesignature.md
+9 -9
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/db95340/packages/types/src/H512.ts#L14)*
*Defined in [H512.ts:14](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/H512.ts#L14)*
**Parameters:**
@@ -113,7 +113,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -130,7 +130,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L43)*
*__description__*: The length of the value
@@ -161,7 +161,7 @@ ___
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8aFixed.ts#L39)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8aFixed.ts#L39)*
*__description__*: Returns the number of bits in the value
@@ -687,7 +687,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -711,7 +711,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L60)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60)*
*__description__*: Returns a hex string representation of the value
@@ -728,7 +728,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L67)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L67)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -762,7 +762,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L74)*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L74)*
*__description__*: Returns the string representation of the value
@@ -777,7 +777,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L82)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L82)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_attestedcandidate_.validityattestation.md
+11 -11
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/db95340/packages/types/src/AttestedCandidate.ts#L54)*
*Defined in [AttestedCandidate.ts:54](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AttestedCandidate.ts#L54)*
**Parameters:**
@@ -42,7 +42,7 @@ getencodedLength(): `number`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)*
*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L97)*
*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L97)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -57,7 +57,7 @@ getisNone(): `boolean`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)*
*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L104)*
*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L104)*
*__description__*: Checks if the Enum points to a [Null](_null_.null.md) type
@@ -72,7 +72,7 @@ getisNull(): `boolean`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)*
*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L111)*
*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L111)*
*__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone)
@@ -87,7 +87,7 @@ gettype(): `string`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)*
*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L118)*
*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L118)*
*__description__*: The name of the type this enum value represents
@@ -102,7 +102,7 @@ getvalue(): [Codec](../interfaces/_types_.codec.md)
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)*
*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L125)*
*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L125)*
*__description__*: The value of the enum
@@ -122,7 +122,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)*
*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L132)*
*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L132)*
*__description__*: Returns a hex string representation of the value
@@ -139,7 +139,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)*
*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L139)*
*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L139)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -154,7 +154,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)*
*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L146)*
*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L146)*
*__description__*: Returns the number representation for the value
@@ -171,7 +171,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)*
*Defined in [codec/EnumType.ts:153](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L153)*
*Defined in [codec/EnumType.ts:153](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L153)*
*__description__*: Returns the string representation of the value
@@ -186,7 +186,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)*
*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L161)*
*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L161)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_attestedcandidate_.validityvote.md
+11 -11
View File
@@ -25,7 +25,7 @@
*Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [codec/Tuple.ts:20](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L20)*
*Defined in [codec/Tuple.ts:20](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L20)*
**Parameters:**
@@ -64,7 +64,7 @@ getTypes(): `Array`<`string`>
*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)*
*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L65)*
*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L65)*
*__description__*: The types definition of the tuple
@@ -79,7 +79,7 @@ getencodedLength(): `number`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)*
*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L56)*
*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L56)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -249,7 +249,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L121)*
*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L121)*
*__description__*: Filters the array with the callback
@@ -669,7 +669,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L130)*
*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L130)*
*__description__*: Maps the array with the callback
@@ -977,7 +977,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L72)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L72)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -994,7 +994,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)*
*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L79)*
*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L79)*
*__description__*: Returns a hex string representation of the value
@@ -1011,7 +1011,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L86)*
*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L86)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1045,7 +1045,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L95)*
*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L95)*
*__description__*: Returns the string representation of the value
@@ -1060,7 +1060,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)*
*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L104)*
*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L104)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1117,7 +1117,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L43)*
*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L43)*
**Type parameters:**
docs/types/classes/_authorityid_.authorityid.html
+11 -11
View File
@@ -1976,7 +1976,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/db95340/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/1e88075/packages/types/src/AccountId.ts#L19" target="_blank">AccountId.ts:19</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2036,7 +2036,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/db95340/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/1e88075/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>
@@ -2045,7 +2045,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/db95340/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/1e88075/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2061,7 +2061,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/db95340/packages/types/src/codec/U8aFixed.ts#L39" target="_blank">codec/U8aFixed.ts:39</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8aFixed.ts#L39" target="_blank">codec/U8aFixed.ts:39</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>
@@ -2728,7 +2728,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/db95340/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</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>
@@ -2759,7 +2759,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/db95340/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</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>
@@ -2769,7 +2769,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/db95340/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/1e88075/packages/types/src/AccountId.ts#L46" target="_blank">AccountId.ts:46</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>
@@ -2787,7 +2787,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/db95340/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/1e88075/packages/types/src/AccountId.ts#L53" target="_blank">AccountId.ts:53</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>
@@ -2795,7 +2795,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>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/db95340/packages/types/src/codec/U8a.ts#L82" target="_blank">codec/U8a.ts:82</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L82" target="_blank">codec/U8a.ts:82</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>
@@ -2828,7 +2828,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/db95340/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/1e88075/packages/types/src/AccountId.ts#L27" target="_blank">AccountId.ts:27</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2889,7 +2889,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":"2018-12-21T12:22:05.953Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:33.654Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_authorityid_.authorityid.md
+10 -10
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/db95340/packages/types/src/AccountId.ts#L19)*
*Defined in [AccountId.ts:19](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountId.ts#L19)*
**Parameters:**
@@ -115,7 +115,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -132,7 +132,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L43)*
*__description__*: The length of the value
@@ -163,7 +163,7 @@ ___
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8aFixed.ts#L39)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8aFixed.ts#L39)*
*__description__*: Returns the number of bits in the value
@@ -689,7 +689,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -713,7 +713,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L60)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60)*
*__description__*: Returns a hex string representation of the value
@@ -732,7 +732,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/AccountId.ts#L46)*
*Defined in [AccountId.ts:46](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountId.ts#L46)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -766,7 +766,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)*
*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/AccountId.ts#L53)*
*Defined in [AccountId.ts:53](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountId.ts#L53)*
*__description__*: Returns the string representation of the value
@@ -781,7 +781,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L82)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L82)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -817,7 +817,7 @@ ___
*Inherited from [AccountId](_accountid_.accountid.md).[encode](_accountid_.accountid.md#encode)*
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/AccountId.ts#L27)*
*Defined in [AccountId.ts:27](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/AccountId.ts#L27)*
**Parameters:**
docs/types/classes/_balance_.balance.html
+10 -10
View File
@@ -1975,7 +1975,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/db95340/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/1e88075/packages/types/src/U128.ts#L14" target="_blank">U128.ts:14</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -1998,7 +1998,7 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from AbstractInt.encodedLength</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L56" target="_blank">codec/AbstractInt.ts:56</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L56" target="_blank">codec/AbstractInt.ts:56</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>
@@ -2131,7 +2131,7 @@
<p>&#x25B8; <strong>bitLength</strong>(): <a href="../modules/_codec_abstractint_.md#uintbitlength">UIntBitLength</a></p>
<p><em>Inherited from AbstractInt.bitLength</em></p>
<p><em>Overrides BN.bitLength</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L63" target="_blank">codec/AbstractInt.ts:63</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L63" target="_blank">codec/AbstractInt.ts:63</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>
@@ -3509,7 +3509,7 @@
<h2 id="tobn">toBn</h2>
<p>&#x25B8; <strong>toBn</strong>(): <code>BN</code></p>
<p><em>Inherited from AbstractInt.toBn</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L70" target="_blank">codec/AbstractInt.ts:70</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L70" target="_blank">codec/AbstractInt.ts:70</a></em></p>
<p><em><strong>description</strong></em>: Returns the BN representation of the number. (Compatibility)</p>
<p><strong>Returns:</strong> <code>BN</code></p>
<hr>
@@ -3546,7 +3546,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/db95340/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/1e88075/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>
@@ -3556,7 +3556,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 AbstractInt.toJSON</em></p>
<p><em>Overrides BN.toJSON</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L82" target="_blank">codec/AbstractInt.ts:82</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L82" target="_blank">codec/AbstractInt.ts:82</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>
@@ -3596,7 +3596,7 @@
<p>&#x25B8; <strong>toString</strong>(base?: <em> <code>undefined</code> | <code>number</code></em>): <code>string</code></p>
<p><em>Inherited from AbstractInt.toString</em></p>
<p><em>Overrides BN.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L92" target="_blank">codec/AbstractInt.ts:92</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L92" target="_blank">codec/AbstractInt.ts:92</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -3645,7 +3645,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em> <code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></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/db95340/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/1e88075/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>
@@ -3862,7 +3862,7 @@
<h2 id="static-decodeabstracint"><code>&lt;Static&gt;</code> decodeAbstracInt</h2>
<p>&#x25B8; <strong>decodeAbstracInt</strong>(value: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>, bitLength: <em><a href="../modules/_codec_abstractint_.md#uintbitlength">UIntBitLength</a></em>, isNegative: <em><code>boolean</code></em>): <code>string</code></p>
<p><em>Inherited from AbstractInt.decodeAbstracInt</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L37" target="_blank">codec/AbstractInt.ts:37</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L37" target="_blank">codec/AbstractInt.ts:37</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -4054,7 +4054,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":"2018-12-21T12:22:06.182Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:33.878Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_balance_.balance.md
+9 -9
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/db95340/packages/types/src/U128.ts#L14)*
*Defined in [U128.ts:14](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/U128.ts#L14)*
**Parameters:**
@@ -48,7 +48,7 @@ getencodedLength(): `number`
*Inherited from AbstractInt.encodedLength*
*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L56)*
*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L56)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -188,7 +188,7 @@ ___
*Overrides BN.bitLength*
*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L63)*
*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L63)*
*__description__*: Returns the number of bits in the value
@@ -1523,7 +1523,7 @@ ___
*Inherited from AbstractInt.toBn*
*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L70)*
*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L70)*
*__description__*: Returns the BN representation of the number. (Compatibility)
@@ -1564,7 +1564,7 @@ ___
*Overrides AbstractInt.toHex*
*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/UInt.ts#L36)*
*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/UInt.ts#L36)*
*__description__*: Returns a hex string representation of the value
@@ -1583,7 +1583,7 @@ ___
*Overrides BN.toJSON*
*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L82)*
*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L82)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1636,7 +1636,7 @@ ___
*Overrides BN.toString*
*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L92)*
*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L92)*
*__description__*: Returns the string representation of the value
@@ -1680,7 +1680,7 @@ ___
*Overrides AbstractInt.toU8a*
*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/UInt.ts#L48)*
*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/UInt.ts#L48)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1884,7 +1884,7 @@ ___
*Inherited from AbstractInt.decodeAbstracInt*
*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L37)*
*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L37)*
**Parameters:**
docs/types/classes/_bft_.bftauthoritysignature.html
+14 -14
View File
@@ -1978,7 +1978,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/db95340/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/1e88075/packages/types/src/Bft.ts#L20" target="_blank">Bft.ts:20</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2009,14 +2009,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/db95340/packages/types/src/codec/Tuple.ts#L65" target="_blank">codec/Tuple.ts:65</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L65" target="_blank">codec/Tuple.ts:65</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/db95340/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/1e88075/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>
@@ -2024,14 +2024,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/db95340/packages/types/src/codec/Tuple.ts#L56" target="_blank">codec/Tuple.ts:56</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L56" target="_blank">codec/Tuple.ts:56</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/db95340/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/1e88075/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>
@@ -2212,7 +2212,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/db95340/packages/types/src/codec/Tuple.ts#L121" target="_blank">codec/Tuple.ts:121</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L121" target="_blank">codec/Tuple.ts:121</a></em></p>
<p><em><strong>description</strong></em>: Filters the array with the callback</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2765,7 +2765,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/db95340/packages/types/src/codec/Tuple.ts#L130" target="_blank">codec/Tuple.ts:130</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L130" target="_blank">codec/Tuple.ts:130</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>
@@ -3147,7 +3147,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/db95340/packages/types/src/codec/Tuple.ts#L72" target="_blank">codec/Tuple.ts:72</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L72" target="_blank">codec/Tuple.ts:72</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>
@@ -3156,7 +3156,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/db95340/packages/types/src/codec/Tuple.ts#L79" target="_blank">codec/Tuple.ts:79</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L79" target="_blank">codec/Tuple.ts:79</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>
@@ -3165,7 +3165,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/db95340/packages/types/src/codec/Tuple.ts#L86" target="_blank">codec/Tuple.ts:86</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L86" target="_blank">codec/Tuple.ts:86</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>
@@ -3183,7 +3183,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/db95340/packages/types/src/codec/Tuple.ts#L95" target="_blank">codec/Tuple.ts:95</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L95" target="_blank">codec/Tuple.ts:95</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>
@@ -3191,7 +3191,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>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/db95340/packages/types/src/codec/Tuple.ts#L104" target="_blank">codec/Tuple.ts:104</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L104" target="_blank">codec/Tuple.ts:104</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>
@@ -3249,7 +3249,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_tuple_.tuple.html">Tuple</a>&lt;<code>S</code>&gt;&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/db95340/packages/types/src/codec/Tuple.ts#L43" target="_blank">codec/Tuple.ts:43</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L43" target="_blank">codec/Tuple.ts:43</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="s---arrayconstructor">S : <code>Array</code>&lt;<a href="../modules/_types_.md#constructor">Constructor</a>&gt;</h4>
<p><strong>Parameters:</strong></p>
@@ -3312,7 +3312,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":"2018-12-21T12:22:06.382Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:34.102Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_bft_.bftauthoritysignature.md
+13 -13
View File
@@ -29,7 +29,7 @@
*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [Bft.ts:20](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Bft.ts#L20)*
*Defined in [Bft.ts:20](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bft.ts#L20)*
**Parameters:**
@@ -67,7 +67,7 @@ getTypes(): `Array`<`string`>
*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)*
*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L65)*
*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L65)*
*__description__*: The types definition of the tuple
@@ -80,7 +80,7 @@ ___
getauthorityId(): [AuthorityId](_authorityid_.authorityid.md)
*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Bft.ts#L31)*
*Defined in [Bft.ts:31](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bft.ts#L31)*
*__description__*: The wrapped \[\[AuthoriyId\]\]
@@ -95,7 +95,7 @@ getencodedLength(): `number`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)*
*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L56)*
*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L56)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -108,7 +108,7 @@ ___
getsignature(): [Signature](_signature_.signature.md)
*Defined in [Bft.ts:38](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Bft.ts#L38)*
*Defined in [Bft.ts:38](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bft.ts#L38)*
*__description__*: The wrapped [Signature](_signature_.signature.md) value
@@ -278,7 +278,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L121)*
*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L121)*
*__description__*: Filters the array with the callback
@@ -698,7 +698,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L130)*
*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L130)*
*__description__*: Maps the array with the callback
@@ -1006,7 +1006,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L72)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L72)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -1023,7 +1023,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)*
*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L79)*
*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L79)*
*__description__*: Returns a hex string representation of the value
@@ -1040,7 +1040,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L86)*
*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L86)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1074,7 +1074,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L95)*
*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L95)*
*__description__*: Returns the string representation of the value
@@ -1089,7 +1089,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)*
*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L104)*
*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L104)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1146,7 +1146,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L43)*
*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L43)*
**Type parameters:**
docs/types/classes/_bft_.bfthashsignature.html
+14 -14
View File
@@ -1978,7 +1978,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/db95340/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/1e88075/packages/types/src/Bft.ts#L51" target="_blank">Bft.ts:51</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2009,7 +2009,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/db95340/packages/types/src/codec/Tuple.ts#L65" target="_blank">codec/Tuple.ts:65</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L65" target="_blank">codec/Tuple.ts:65</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>
@@ -2017,21 +2017,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/db95340/packages/types/src/codec/Tuple.ts#L56" target="_blank">codec/Tuple.ts:56</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L56" target="_blank">codec/Tuple.ts:56</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/db95340/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/1e88075/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/db95340/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/1e88075/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>
@@ -2212,7 +2212,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/db95340/packages/types/src/codec/Tuple.ts#L121" target="_blank">codec/Tuple.ts:121</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L121" target="_blank">codec/Tuple.ts:121</a></em></p>
<p><em><strong>description</strong></em>: Filters the array with the callback</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2765,7 +2765,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/db95340/packages/types/src/codec/Tuple.ts#L130" target="_blank">codec/Tuple.ts:130</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L130" target="_blank">codec/Tuple.ts:130</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>
@@ -3147,7 +3147,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/db95340/packages/types/src/codec/Tuple.ts#L72" target="_blank">codec/Tuple.ts:72</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L72" target="_blank">codec/Tuple.ts:72</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>
@@ -3156,7 +3156,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/db95340/packages/types/src/codec/Tuple.ts#L79" target="_blank">codec/Tuple.ts:79</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L79" target="_blank">codec/Tuple.ts:79</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>
@@ -3165,7 +3165,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/db95340/packages/types/src/codec/Tuple.ts#L86" target="_blank">codec/Tuple.ts:86</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L86" target="_blank">codec/Tuple.ts:86</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>
@@ -3183,7 +3183,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/db95340/packages/types/src/codec/Tuple.ts#L95" target="_blank">codec/Tuple.ts:95</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L95" target="_blank">codec/Tuple.ts:95</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>
@@ -3191,7 +3191,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>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/db95340/packages/types/src/codec/Tuple.ts#L104" target="_blank">codec/Tuple.ts:104</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L104" target="_blank">codec/Tuple.ts:104</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>
@@ -3249,7 +3249,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_tuple_.tuple.html">Tuple</a>&lt;<code>S</code>&gt;&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/db95340/packages/types/src/codec/Tuple.ts#L43" target="_blank">codec/Tuple.ts:43</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L43" target="_blank">codec/Tuple.ts:43</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="s---arrayconstructor">S : <code>Array</code>&lt;<a href="../modules/_types_.md#constructor">Constructor</a>&gt;</h4>
<p><strong>Parameters:</strong></p>
@@ -3312,7 +3312,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":"2018-12-21T12:22:06.590Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:34.302Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_bft_.bfthashsignature.md
+13 -13
View File
@@ -29,7 +29,7 @@
*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [Bft.ts:51](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Bft.ts#L51)*
*Defined in [Bft.ts:51](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bft.ts#L51)*
**Parameters:**
@@ -67,7 +67,7 @@ getTypes(): `Array`<`string`>
*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)*
*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L65)*
*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L65)*
*__description__*: The types definition of the tuple
@@ -82,7 +82,7 @@ getencodedLength(): `number`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)*
*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L56)*
*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L56)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -95,7 +95,7 @@ ___
gethash(): [Hash](_hash_.hash.md)
*Defined in [Bft.ts:62](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Bft.ts#L62)*
*Defined in [Bft.ts:62](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bft.ts#L62)*
*__description__*: The wrapped [Hash](_hash_.hash.md)
@@ -108,7 +108,7 @@ ___
getsignature(): [Signature](_signature_.signature.md)
*Defined in [Bft.ts:69](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Bft.ts#L69)*
*Defined in [Bft.ts:69](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bft.ts#L69)*
*__description__*: The wrapped [Signature](_signature_.signature.md)
@@ -278,7 +278,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L121)*
*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L121)*
*__description__*: Filters the array with the callback
@@ -698,7 +698,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L130)*
*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L130)*
*__description__*: Maps the array with the callback
@@ -1006,7 +1006,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L72)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L72)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -1023,7 +1023,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)*
*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L79)*
*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L79)*
*__description__*: Returns a hex string representation of the value
@@ -1040,7 +1040,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L86)*
*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L86)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1074,7 +1074,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L95)*
*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L95)*
*__description__*: Returns the string representation of the value
@@ -1089,7 +1089,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)*
*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L104)*
*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L104)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1146,7 +1146,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L43)*
*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L43)*
**Type parameters:**
docs/types/classes/_block_.block.html
+15 -15
View File
@@ -1979,7 +1979,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/db95340/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/1e88075/packages/types/src/Block.ts#L24" target="_blank">Block.ts:24</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2015,7 +2015,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/db95340/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/1e88075/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>
@@ -2023,28 +2023,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/db95340/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/1e88075/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/db95340/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/1e88075/packages/types/src/Block.ts#L35" target="_blank">Block.ts:35</a></em></p>
<p><em><strong>description</strong></em>: The <a href="_extrinsics_.extrinsics.html">Extrinsics</a> conatined 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/db95340/packages/types/src/Block.ts#L42" target="_blank">Block.ts:42</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Block.ts#L42" target="_blank">Block.ts:42</a></em></p>
<p><em><strong>description</strong></em>: Coinvenience getter, encoded the <a href="_hash_.hash.html">Hash</a> for the block</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/db95340/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/1e88075/packages/types/src/Block.ts#L51" target="_blank">Block.ts:51</a></em></p>
<p><em><strong>description</strong></em>: The <a href="_header_.header.html">Header</a> in the block</p>
<p><strong>Returns:</strong> <a href="_header_.header.html">Header</a></p>
<hr>
@@ -2125,7 +2125,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/db95340/packages/types/src/codec/Struct.ts#L159" target="_blank">codec/Struct.ts:159</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L159" target="_blank">codec/Struct.ts:159</a></em></p>
<p><em><strong>description</strong></em>: Returns a specific names entry in the structure</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2150,7 +2150,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L166" target="_blank">codec/Struct.ts:166</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>
@@ -2229,7 +2229,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L173" target="_blank">codec/Struct.ts:173</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>
@@ -2238,7 +2238,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L180" target="_blank">codec/Struct.ts:180</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>
@@ -2247,7 +2247,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L187" target="_blank">codec/Struct.ts:187</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>
@@ -2256,7 +2256,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/db95340/packages/types/src/codec/Struct.ts#L201" target="_blank">codec/Struct.ts:201</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L201" target="_blank">codec/Struct.ts:201</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>
@@ -2264,7 +2264,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>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/db95340/packages/types/src/codec/Struct.ts#L209" target="_blank">codec/Struct.ts:209</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L209" target="_blank">codec/Struct.ts:209</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>
@@ -2297,7 +2297,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/db95340/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/1e88075/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>
@@ -2360,7 +2360,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":"2018-12-21T12:22:06.642Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:34.362Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_block_.block.md
+14 -14
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/db95340/packages/types/src/Block.ts#L24)*
*Defined in [Block.ts:24](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Block.ts#L24)*
**Parameters:**
@@ -76,7 +76,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L142)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L142)*
*__description__*: Returns the Type description to sthe structure
@@ -91,7 +91,7 @@ getencodedLength(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L149)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L149)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -104,7 +104,7 @@ ___
getextrinsics(): [Extrinsics](_extrinsics_.extrinsics.md)
*Defined in [Block.ts:35](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Block.ts#L35)*
*Defined in [Block.ts:35](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Block.ts#L35)*
*__description__*: The [Extrinsics](_extrinsics_.extrinsics.md) conatined in the block
@@ -117,7 +117,7 @@ ___
gethash(): [Hash](_hash_.hash.md)
*Defined in [Block.ts:42](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Block.ts#L42)*
*Defined in [Block.ts:42](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Block.ts#L42)*
*__description__*: Coinvenience getter, encoded the [Hash](_hash_.hash.md) for the block
@@ -130,7 +130,7 @@ ___
getheader(): [Header](_header_.header.md)
*Defined in [Block.ts:51](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Block.ts#L51)*
*Defined in [Block.ts:51](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Block.ts#L51)*
*__description__*: The [Header](_header_.header.md) in the block
@@ -232,7 +232,7 @@ ___
*Overrides Map.get*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L159)*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L159)*
*__description__*: Returns a specific names entry in the structure
@@ -253,7 +253,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L166)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -328,7 +328,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L173)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L173)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -345,7 +345,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L180)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Returns a hex string representation of the value
@@ -362,7 +362,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L187)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L187)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -379,7 +379,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L201)*
*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L201)*
*__description__*: Returns the string representation of the value
@@ -394,7 +394,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L209)*
*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L209)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -430,7 +430,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L122)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L122)*
**Type parameters:**
docs/types/classes/_blocknumber_.blocknumber.html
+10 -10
View File
@@ -1975,7 +1975,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/db95340/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/1e88075/packages/types/src/U64.ts#L14" target="_blank">U64.ts:14</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -1998,7 +1998,7 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from AbstractInt.encodedLength</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L56" target="_blank">codec/AbstractInt.ts:56</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L56" target="_blank">codec/AbstractInt.ts:56</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>
@@ -2131,7 +2131,7 @@
<p>&#x25B8; <strong>bitLength</strong>(): <a href="../modules/_codec_abstractint_.md#uintbitlength">UIntBitLength</a></p>
<p><em>Inherited from AbstractInt.bitLength</em></p>
<p><em>Overrides BN.bitLength</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L63" target="_blank">codec/AbstractInt.ts:63</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L63" target="_blank">codec/AbstractInt.ts:63</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>
@@ -3509,7 +3509,7 @@
<h2 id="tobn">toBn</h2>
<p>&#x25B8; <strong>toBn</strong>(): <code>BN</code></p>
<p><em>Inherited from AbstractInt.toBn</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L70" target="_blank">codec/AbstractInt.ts:70</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L70" target="_blank">codec/AbstractInt.ts:70</a></em></p>
<p><em><strong>description</strong></em>: Returns the BN representation of the number. (Compatibility)</p>
<p><strong>Returns:</strong> <code>BN</code></p>
<hr>
@@ -3546,7 +3546,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/db95340/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/1e88075/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>
@@ -3556,7 +3556,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 AbstractInt.toJSON</em></p>
<p><em>Overrides BN.toJSON</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L82" target="_blank">codec/AbstractInt.ts:82</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L82" target="_blank">codec/AbstractInt.ts:82</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>
@@ -3596,7 +3596,7 @@
<p>&#x25B8; <strong>toString</strong>(base?: <em> <code>undefined</code> | <code>number</code></em>): <code>string</code></p>
<p><em>Inherited from AbstractInt.toString</em></p>
<p><em>Overrides BN.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L92" target="_blank">codec/AbstractInt.ts:92</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L92" target="_blank">codec/AbstractInt.ts:92</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -3645,7 +3645,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em> <code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></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/db95340/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/1e88075/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>
@@ -3862,7 +3862,7 @@
<h2 id="static-decodeabstracint"><code>&lt;Static&gt;</code> decodeAbstracInt</h2>
<p>&#x25B8; <strong>decodeAbstracInt</strong>(value: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>, bitLength: <em><a href="../modules/_codec_abstractint_.md#uintbitlength">UIntBitLength</a></em>, isNegative: <em><code>boolean</code></em>): <code>string</code></p>
<p><em>Inherited from AbstractInt.decodeAbstracInt</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L37" target="_blank">codec/AbstractInt.ts:37</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L37" target="_blank">codec/AbstractInt.ts:37</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -4054,7 +4054,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":"2018-12-21T12:22:07.146Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:34.554Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_blocknumber_.blocknumber.md
+9 -9
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/db95340/packages/types/src/U64.ts#L14)*
*Defined in [U64.ts:14](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/U64.ts#L14)*
**Parameters:**
@@ -48,7 +48,7 @@ getencodedLength(): `number`
*Inherited from AbstractInt.encodedLength*
*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L56)*
*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L56)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -188,7 +188,7 @@ ___
*Overrides BN.bitLength*
*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L63)*
*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L63)*
*__description__*: Returns the number of bits in the value
@@ -1523,7 +1523,7 @@ ___
*Inherited from AbstractInt.toBn*
*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L70)*
*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L70)*
*__description__*: Returns the BN representation of the number. (Compatibility)
@@ -1564,7 +1564,7 @@ ___
*Overrides AbstractInt.toHex*
*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/UInt.ts#L36)*
*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/UInt.ts#L36)*
*__description__*: Returns a hex string representation of the value
@@ -1583,7 +1583,7 @@ ___
*Overrides BN.toJSON*
*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L82)*
*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L82)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1636,7 +1636,7 @@ ___
*Overrides BN.toString*
*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L92)*
*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L92)*
*__description__*: Returns the string representation of the value
@@ -1680,7 +1680,7 @@ ___
*Overrides AbstractInt.toU8a*
*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/UInt.ts#L48)*
*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/UInt.ts#L48)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1884,7 +1884,7 @@ ___
*Inherited from AbstractInt.decodeAbstracInt*
*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L37)*
*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L37)*
**Parameters:**
docs/types/classes/_bool_.bool.html
+7 -7
View File
@@ -1973,7 +1973,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/db95340/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/1e88075/packages/types/src/Bool.ts#L15" target="_blank">Bool.ts:15</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2003,7 +2003,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/db95340/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/1e88075/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>
@@ -2012,7 +2012,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/db95340/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/1e88075/packages/types/src/Bool.ts#L42" target="_blank">Bool.ts:42</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>
@@ -2020,7 +2020,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/db95340/packages/types/src/Bool.ts#L49" target="_blank">Bool.ts:49</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bool.ts#L49" target="_blank">Bool.ts:49</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>
@@ -2028,14 +2028,14 @@
<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/db95340/packages/types/src/Bool.ts#L56" target="_blank">Bool.ts:56</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bool.ts#L56" target="_blank">Bool.ts:56</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/db95340/packages/types/src/Bool.ts#L64" target="_blank">Bool.ts:64</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bool.ts#L64" target="_blank">Bool.ts:64</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>
@@ -2099,7 +2099,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":"2018-12-21T12:22:07.166Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:34.570Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_bool_.bool.md
+6 -6
View File
@@ -22,7 +22,7 @@
⊕ **new Bool**(value?: * [Bool](_bool_.bool.md) &#124; `Boolean` &#124; `Uint8Array` &#124; `boolean` &#124; `number`*): [Bool](_bool_.bool.md)
*Defined in [Bool.ts:15](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Bool.ts#L15)*
*Defined in [Bool.ts:15](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/Bool.ts#L35)*
*Defined in [Bool.ts:35](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bool.ts#L35)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -72,7 +72,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [Bool.ts:42](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Bool.ts#L42)*
*Defined in [Bool.ts:42](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bool.ts#L42)*
*__description__*: Returns a hex string representation of the value
@@ -87,7 +87,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [Bool.ts:49](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Bool.ts#L49)*
*Defined in [Bool.ts:49](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bool.ts#L49)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -102,7 +102,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [Bool.ts:56](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Bool.ts#L56)*
*Defined in [Bool.ts:56](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bool.ts#L56)*
*__description__*: Returns the string representation of the value
@@ -115,7 +115,7 @@ ___
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Defined in [Bool.ts:64](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Bool.ts#L64)*
*Defined in [Bool.ts:64](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bool.ts#L64)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_bytes_.bytes.html
+9 -9
View File
@@ -1981,7 +1981,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/db95340/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/1e88075/packages/types/src/Bytes.ts#L18" target="_blank">Bytes.ts:18</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2039,7 +2039,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/db95340/packages/types/src/Bytes.ts#L64" target="_blank">Bytes.ts:64</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bytes.ts#L64" target="_blank">Bytes.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>
@@ -2048,7 +2048,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/db95340/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/1e88075/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2723,7 +2723,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/db95340/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</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>
@@ -2754,7 +2754,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/db95340/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</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>
@@ -2763,7 +2763,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/db95340/packages/types/src/codec/U8a.ts#L67" target="_blank">codec/U8a.ts:67</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L67" target="_blank">codec/U8a.ts:67</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>
@@ -2781,7 +2781,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/db95340/packages/types/src/codec/U8a.ts#L74" target="_blank">codec/U8a.ts:74</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L74" target="_blank">codec/U8a.ts:74</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>
@@ -2789,7 +2789,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>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/db95340/packages/types/src/Bytes.ts#L72" target="_blank">Bytes.ts:72</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bytes.ts#L72" target="_blank">Bytes.ts:72</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>
@@ -2861,7 +2861,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":"2018-12-21T12:22:07.322Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:34.730Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_bytes_.bytes.md
+8 -8
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/db95340/packages/types/src/Bytes.ts#L18)*
*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bytes.ts#L18)*
**Parameters:**
@@ -125,7 +125,7 @@ getencodedLength(): `number`
*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Bytes.ts#L64)*
*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bytes.ts#L64)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -142,7 +142,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L43)*
*__description__*: The length of the value
@@ -684,7 +684,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -708,7 +708,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L60)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60)*
*__description__*: Returns a hex string representation of the value
@@ -725,7 +725,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L67)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L67)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -759,7 +759,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L74)*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L74)*
*__description__*: Returns the string representation of the value
@@ -774,7 +774,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Bytes.ts#L72)*
*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bytes.ts#L72)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_chainproperties_.chainproperties.html
+8 -8
View File
@@ -1973,7 +1973,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/db95340/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/1e88075/packages/types/src/ChainProperties.ts#L17" target="_blank">ChainProperties.ts:17</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2001,7 +2001,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/db95340/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/1e88075/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>
@@ -2010,7 +2010,7 @@
<h2 id="get">get</h2>
<p>&#x25B8; <strong>get</strong>(name: <em><code>string</code></em>): <code>any</code> | <code>undefined</code></p>
<p><em>Overrides Map.get</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/ChainProperties.ts#L37" target="_blank">ChainProperties.ts:37</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ChainProperties.ts#L37" target="_blank">ChainProperties.ts:37</a></em></p>
<p><em><strong>description</strong></em>: Returns a specific names entry in the structure</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2035,7 +2035,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/db95340/packages/types/src/ChainProperties.ts#L44" target="_blank">ChainProperties.ts:44</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ChainProperties.ts#L44" target="_blank">ChainProperties.ts:44</a></em></p>
<p><em><strong>description</strong></em>: Unimplemented, will throw</p>
<p><strong>Returns:</strong> <code>string</code></p>
<hr>
@@ -2043,7 +2043,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/db95340/packages/types/src/ChainProperties.ts#L51" target="_blank">ChainProperties.ts:51</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ChainProperties.ts#L51" target="_blank">ChainProperties.ts:51</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>
@@ -2051,14 +2051,14 @@
<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/db95340/packages/types/src/ChainProperties.ts#L62" target="_blank">ChainProperties.ts:62</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ChainProperties.ts#L62" target="_blank">ChainProperties.ts:62</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/db95340/packages/types/src/ChainProperties.ts#L69" target="_blank">ChainProperties.ts:69</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ChainProperties.ts#L69" target="_blank">ChainProperties.ts:69</a></em></p>
<p><em><strong>description</strong></em>: Unimplemented, will throw</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2120,7 +2120,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":"2018-12-21T12:22:07.338Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:34.754Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_chainproperties_.chainproperties.md
+7 -7
View File
@@ -22,7 +22,7 @@
⊕ **new ChainProperties**(value?: * `object` &#124; `null`*): [ChainProperties](_chainproperties_.chainproperties.md)
*Defined in [ChainProperties.ts:17](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/ChainProperties.ts#L17)*
*Defined in [ChainProperties.ts:17](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/ChainProperties.ts#L29)*
*Defined in [ChainProperties.ts:29](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ChainProperties.ts#L29)*
*__description__*: Always 0, never encodes as a Uint8Array
@@ -72,7 +72,7 @@ ___
*Overrides Map.get*
*Defined in [ChainProperties.ts:37](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/ChainProperties.ts#L37)*
*Defined in [ChainProperties.ts:37](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ChainProperties.ts#L37)*
*__description__*: Returns a specific names entry in the structure
@@ -93,7 +93,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [ChainProperties.ts:44](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/ChainProperties.ts#L44)*
*Defined in [ChainProperties.ts:44](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ChainProperties.ts#L44)*
*__description__*: Unimplemented, will throw
@@ -108,7 +108,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [ChainProperties.ts:51](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/ChainProperties.ts#L51)*
*Defined in [ChainProperties.ts:51](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ChainProperties.ts#L51)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -123,7 +123,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [ChainProperties.ts:62](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/ChainProperties.ts#L62)*
*Defined in [ChainProperties.ts:62](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ChainProperties.ts#L62)*
*__description__*: Returns the string representation of the value
@@ -136,7 +136,7 @@ ___
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Defined in [ChainProperties.ts:69](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/ChainProperties.ts#L69)*
*Defined in [ChainProperties.ts:69](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ChainProperties.ts#L69)*
*__description__*: Unimplemented, will throw
docs/types/classes/_codec_base_.base.html
+2 -2
View File
@@ -1976,7 +1976,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/db95340/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/1e88075/packages/types/src/codec/Base.ts#L10" target="_blank">codec/Base.ts:10</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2037,7 +2037,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":"2018-12-21T12:22:17.611Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:45.459Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"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/db95340/packages/types/src/codec/Base.ts#L10)*
*Defined in [codec/Base.ts:10](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Base.ts#L10)*
**Parameters:**
docs/types/classes/_codec_compact_.compact.html
+16 -16
View File
@@ -1974,7 +1974,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="../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/db95340/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/1e88075/packages/types/src/codec/Compact.ts#L23" target="_blank">codec/Compact.ts:23</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2003,25 +2003,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/db95340/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/1e88075/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/db95340/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/1e88075/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/db95340/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/1e88075/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/db95340/packages/types/src/codec/Compact.ts#L70" target="_blank">codec/Compact.ts:70</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Compact.ts#L70" target="_blank">codec/Compact.ts:70</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>
@@ -2029,14 +2029,14 @@
<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/db95340/packages/types/src/codec/Compact.ts#L77" target="_blank">codec/Compact.ts:77</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Compact.ts#L77" target="_blank">codec/Compact.ts:77</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>
<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/db95340/packages/types/src/codec/Compact.ts#L84" target="_blank">codec/Compact.ts:84</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Compact.ts#L84" target="_blank">codec/Compact.ts:84</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>
@@ -2044,7 +2044,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/db95340/packages/types/src/codec/Compact.ts#L91" target="_blank">codec/Compact.ts:91</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Compact.ts#L91" target="_blank">codec/Compact.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>any</code></p>
<hr>
@@ -2052,14 +2052,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/db95340/packages/types/src/codec/Compact.ts#L98" target="_blank">codec/Compact.ts:98</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Compact.ts#L98" target="_blank">codec/Compact.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>
<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/db95340/packages/types/src/codec/Compact.ts#L105" target="_blank">codec/Compact.ts:105</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Compact.ts#L105" target="_blank">codec/Compact.ts:105</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>
@@ -2067,14 +2067,14 @@
<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/db95340/packages/types/src/codec/Compact.ts#L112" target="_blank">codec/Compact.ts:112</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Compact.ts#L112" target="_blank">codec/Compact.ts:112</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/db95340/packages/types/src/codec/Compact.ts#L120" target="_blank">codec/Compact.ts:120</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Compact.ts#L120" target="_blank">codec/Compact.ts:120</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>
@@ -2098,7 +2098,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="../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/db95340/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/1e88075/packages/types/src/codec/Compact.ts#L51" target="_blank">codec/Compact.ts:51</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2123,7 +2123,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/db95340/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/1e88075/packages/types/src/codec/Compact.ts#L45" target="_blank">codec/Compact.ts:45</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2151,7 +2151,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/db95340/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/1e88075/packages/types/src/codec/Compact.ts#L28" target="_blank">codec/Compact.ts:28</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.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":"2018-12-21T12:22:17.639Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:45.475Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_codec_compact_.compact.md
+15 -15
View File
@@ -24,7 +24,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Compact.ts:23](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Compact.ts#L23)*
*Defined in [codec/Compact.ts:23](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Compact.ts#L23)*
**Parameters:**
@@ -45,7 +45,7 @@ ___
**● addLengthPrefix**: *`compactAddLength`* = compactAddLength
*Defined in [codec/Compact.ts:41](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Compact.ts#L41)*
*Defined in [codec/Compact.ts:41](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Compact.ts#L41)*
Prepend a Uint8Array with its compact length.
*__param__*: The Uint8Array to be prefixed
@@ -57,7 +57,7 @@ ___
**● decodeU8a**: *`compactFromU8a`* = compactFromU8a
*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Compact.ts#L42)*
*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Compact.ts#L42)*
___
<a id="encodeu8a"></a>
@@ -66,7 +66,7 @@ ___
**● encodeU8a**: *`compactToU8a`* = compactToU8a
*Defined in [codec/Compact.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Compact.ts#L43)*
*Defined in [codec/Compact.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Compact.ts#L43)*
___
@@ -78,7 +78,7 @@ ___
getencodedLength(): `number`
*Defined in [codec/Compact.ts:70](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Compact.ts#L70)*
*Defined in [codec/Compact.ts:70](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Compact.ts#L70)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -94,7 +94,7 @@ ___
▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)
*Defined in [codec/Compact.ts:77](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Compact.ts#L77)*
*Defined in [codec/Compact.ts:77](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Compact.ts#L77)*
*__description__*: Returns the number of bits in the value
@@ -107,7 +107,7 @@ ___
▸ **toBn**(): `BN`
*Defined in [codec/Compact.ts:84](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Compact.ts#L84)*
*Defined in [codec/Compact.ts:84](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Compact.ts#L84)*
*__description__*: Returns the BN representation of the number
@@ -122,7 +122,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/Compact.ts:91](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Compact.ts#L91)*
*Defined in [codec/Compact.ts:91](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Compact.ts#L91)*
*__description__*: Returns a hex string representation of the value
@@ -137,7 +137,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/Compact.ts:98](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Compact.ts#L98)*
*Defined in [codec/Compact.ts:98](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Compact.ts#L98)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -150,7 +150,7 @@ ___
▸ **toNumber**(): `number`
*Defined in [codec/Compact.ts:105](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Compact.ts#L105)*
*Defined in [codec/Compact.ts:105](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Compact.ts#L105)*
*__description__*: Returns the number representation for the value
@@ -165,7 +165,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [codec/Compact.ts:112](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Compact.ts#L112)*
*Defined in [codec/Compact.ts:112](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Compact.ts#L112)*
*__description__*: Returns the string representation of the value
@@ -178,7 +178,7 @@ ___
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Defined in [codec/Compact.ts:120](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Compact.ts#L120)*
*Defined in [codec/Compact.ts:120](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Compact.ts#L120)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -197,7 +197,7 @@ ___
▸ **decodeCompact**(Type: *[Constructor](../modules/_types_.md#constructor)< [UInt](_codec_uint_.uint.md) &#124; [Moment](_moment_.moment.md)>*, value: *[AnyNumber](../modules/_types_.md#anynumber)*): [Moment](_moment_.moment.md) &#124; [UInt](_codec_uint_.uint.md)
*Defined in [codec/Compact.ts:51](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Compact.ts#L51)*
*Defined in [codec/Compact.ts:51](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Compact.ts#L51)*
**Parameters:**
@@ -215,7 +215,7 @@ ___
▸ **stripLengthPrefix**(u8a: *`Uint8Array`*, bitLength?: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*): `Uint8Array`
*Defined in [codec/Compact.ts:45](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Compact.ts#L45)*
*Defined in [codec/Compact.ts:45](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Compact.ts#L45)*
**Parameters:**
@@ -233,7 +233,7 @@ ___
▸ **with**(Type: *[Constructor](../modules/_types_.md#constructor)< [UInt](_codec_uint_.uint.md) &#124; [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/db95340/packages/types/src/codec/Compact.ts#L28)*
*Defined in [codec/Compact.ts:28](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Compact.ts#L28)*
**Parameters:**
docs/types/classes/_codec_enum_.enum.html
+9 -9
View File
@@ -1977,7 +1977,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/db95340/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/1e88075/packages/types/src/codec/Enum.ts#L29" target="_blank">codec/Enum.ts:29</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2006,7 +2006,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/db95340/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/1e88075/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>
@@ -2015,7 +2015,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/db95340/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/1e88075/packages/types/src/codec/Enum.ts#L71" target="_blank">codec/Enum.ts:71</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>
@@ -2023,14 +2023,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/db95340/packages/types/src/codec/Enum.ts#L78" target="_blank">codec/Enum.ts:78</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Enum.ts#L78" target="_blank">codec/Enum.ts:78</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/db95340/packages/types/src/codec/Enum.ts#L85" target="_blank">codec/Enum.ts:85</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Enum.ts#L85" target="_blank">codec/Enum.ts:85</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>
@@ -2038,14 +2038,14 @@
<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/db95340/packages/types/src/codec/Enum.ts#L92" target="_blank">codec/Enum.ts:92</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Enum.ts#L92" target="_blank">codec/Enum.ts:92</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/db95340/packages/types/src/codec/Enum.ts#L100" target="_blank">codec/Enum.ts:100</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Enum.ts#L100" target="_blank">codec/Enum.ts:100</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>
@@ -2069,7 +2069,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/db95340/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/1e88075/packages/types/src/codec/Enum.ts#L47" target="_blank">codec/Enum.ts:47</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2134,7 +2134,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":"2018-12-21T12:22:17.651Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:45.487Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_codec_enum_.enum.md
+8 -8
View File
@@ -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/db95340/packages/types/src/codec/Enum.ts#L29)*
*Defined in [codec/Enum.ts:29](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/codec/Enum.ts#L64)*
*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Enum.ts#L64)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -69,7 +69,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Enum.ts#L71)*
*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Enum.ts#L71)*
*__description__*: Returns a hex string representation of the value
@@ -84,7 +84,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Enum.ts#L78)*
*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Enum.ts#L78)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -97,7 +97,7 @@ ___
▸ **toNumber**(): `number`
*Defined in [codec/Enum.ts:85](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Enum.ts#L85)*
*Defined in [codec/Enum.ts:85](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Enum.ts#L85)*
*__description__*: Returns the number representation for the value
@@ -112,7 +112,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [codec/Enum.ts:92](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Enum.ts#L92)*
*Defined in [codec/Enum.ts:92](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Enum.ts#L92)*
*__description__*: Returns the string representation of the value
@@ -125,7 +125,7 @@ ___
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Defined in [codec/Enum.ts:100](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Enum.ts#L100)*
*Defined in [codec/Enum.ts:100](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Enum.ts#L100)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -144,7 +144,7 @@ ___
▸ **decodeEnum**(def: *`EnumDef`*, value: * [Enum](_codec_enum_.enum.md) &#124; `Uint8Array` &#124; `string` &#124; `number`*): `number` &#124; `undefined`
*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Enum.ts#L47)*
*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Enum.ts#L47)*
**Parameters:**
docs/types/classes/_codec_enumtype_.enumtype.html
+12 -12
View File
@@ -1982,7 +1982,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/db95340/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/1e88075/packages/types/src/codec/EnumType.ts#L32" target="_blank">codec/EnumType.ts:32</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2012,35 +2012,35 @@
<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/db95340/packages/types/src/codec/EnumType.ts#L97" target="_blank">codec/EnumType.ts:97</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L97" target="_blank">codec/EnumType.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="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/db95340/packages/types/src/codec/EnumType.ts#L104" target="_blank">codec/EnumType.ts:104</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L104" target="_blank">codec/EnumType.ts:104</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/db95340/packages/types/src/codec/EnumType.ts#L111" target="_blank">codec/EnumType.ts:111</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L111" target="_blank">codec/EnumType.ts:111</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/db95340/packages/types/src/codec/EnumType.ts#L118" target="_blank">codec/EnumType.ts:118</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L118" target="_blank">codec/EnumType.ts:118</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/db95340/packages/types/src/codec/EnumType.ts#L125" target="_blank">codec/EnumType.ts:125</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L125" target="_blank">codec/EnumType.ts:125</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>
@@ -2049,7 +2049,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/db95340/packages/types/src/codec/EnumType.ts#L132" target="_blank">codec/EnumType.ts:132</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L132" target="_blank">codec/EnumType.ts:132</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>
@@ -2057,14 +2057,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/db95340/packages/types/src/codec/EnumType.ts#L139" target="_blank">codec/EnumType.ts:139</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L139" target="_blank">codec/EnumType.ts:139</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/db95340/packages/types/src/codec/EnumType.ts#L146" target="_blank">codec/EnumType.ts:146</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L146" target="_blank">codec/EnumType.ts:146</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>
@@ -2072,14 +2072,14 @@
<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/db95340/packages/types/src/codec/EnumType.ts#L153" target="_blank">codec/EnumType.ts:153</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L153" target="_blank">codec/EnumType.ts:153</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/db95340/packages/types/src/codec/EnumType.ts#L161" target="_blank">codec/EnumType.ts:161</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L161" target="_blank">codec/EnumType.ts:161</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>
@@ -2143,7 +2143,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":"2018-12-21T12:22:17.675Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:45.511Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_codec_enumtype_.enumtype.md
+11 -11
View File
@@ -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/db95340/packages/types/src/codec/EnumType.ts#L32)*
*Defined in [codec/EnumType.ts:32](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L32)*
**Parameters:**
@@ -60,7 +60,7 @@ ___
getencodedLength(): `number`
*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L97)*
*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L97)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -73,7 +73,7 @@ ___
getisNone(): `boolean`
*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L104)*
*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L104)*
*__description__*: Checks if the Enum points to a [Null](_null_.null.md) type
@@ -86,7 +86,7 @@ ___
getisNull(): `boolean`
*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L111)*
*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L111)*
*__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone)
@@ -99,7 +99,7 @@ ___
gettype(): `string`
*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L118)*
*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L118)*
*__description__*: The name of the type this enum value represents
@@ -112,7 +112,7 @@ ___
getvalue(): [Codec](../interfaces/_types_.codec.md)
*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L125)*
*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L125)*
*__description__*: The value of the enum
@@ -130,7 +130,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L132)*
*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L132)*
*__description__*: Returns a hex string representation of the value
@@ -145,7 +145,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L139)*
*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L139)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -158,7 +158,7 @@ ___
▸ **toNumber**(): `number`
*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L146)*
*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L146)*
*__description__*: Returns the number representation for the value
@@ -173,7 +173,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [codec/EnumType.ts:153](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L153)*
*Defined in [codec/EnumType.ts:153](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L153)*
*__description__*: Returns the string representation of the value
@@ -186,7 +186,7 @@ ___
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L161)*
*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L161)*
*__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/db95340/packages/types/src/codec/Int.ts#L21)*
*Defined in [codec/Int.ts:21](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/codec/Int.ts#L36)*
*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Int.ts#L36)*
*__description__*: Returns a hex string representation of the value
@@ -77,7 +77,7 @@ ___
*Overrides AbstractInt.toU8a*
*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Int.ts#L48)*
*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/1e88075/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
+13 -13
View File
@@ -1976,7 +1976,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/db95340/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/1e88075/packages/types/src/codec/Option.ts#L19" target="_blank">codec/Option.ts:19</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2002,28 +2002,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/db95340/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/1e88075/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/db95340/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/1e88075/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/db95340/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/1e88075/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/db95340/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/1e88075/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>
@@ -2032,7 +2032,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/db95340/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/1e88075/packages/types/src/codec/Option.ts#L81" target="_blank">codec/Option.ts:81</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>
@@ -2040,7 +2040,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/db95340/packages/types/src/codec/Option.ts#L88" target="_blank">codec/Option.ts:88</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Option.ts#L88" target="_blank">codec/Option.ts:88</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>
@@ -2048,14 +2048,14 @@
<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/db95340/packages/types/src/codec/Option.ts#L95" target="_blank">codec/Option.ts:95</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Option.ts#L95" target="_blank">codec/Option.ts:95</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/db95340/packages/types/src/codec/Option.ts#L103" target="_blank">codec/Option.ts:103</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Option.ts#L103" target="_blank">codec/Option.ts:103</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>
@@ -2079,14 +2079,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/db95340/packages/types/src/codec/Option.ts#L121" target="_blank">codec/Option.ts:121</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Option.ts#L121" target="_blank">codec/Option.ts:121</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/db95340/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/1e88075/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>
@@ -2113,7 +2113,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/db95340/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/1e88075/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>
@@ -2176,7 +2176,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":"2018-12-21T12:22:17.711Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:45.543Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_codec_option_.option.md
+12 -12
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/db95340/packages/types/src/codec/Option.ts#L19)*
*Defined in [codec/Option.ts:19](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/codec/Option.ts#L52)*
*Defined in [codec/Option.ts:52](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/codec/Option.ts#L60)*
*Defined in [codec/Option.ts:60](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/codec/Option.ts#L67)*
*Defined in [codec/Option.ts:67](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/codec/Option.ts#L74)*
*Defined in [codec/Option.ts:74](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Option.ts#L74)*
*__description__*: The actual value for the Option
@@ -104,7 +104,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/Option.ts:81](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Option.ts#L81)*
*Defined in [codec/Option.ts:81](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Option.ts#L81)*
*__description__*: Returns a hex string representation of the value
@@ -119,7 +119,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/Option.ts:88](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Option.ts#L88)*
*Defined in [codec/Option.ts:88](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Option.ts#L88)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -134,7 +134,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [codec/Option.ts:95](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Option.ts#L95)*
*Defined in [codec/Option.ts:95](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Option.ts#L95)*
*__description__*: Returns the string representation of the value
@@ -147,7 +147,7 @@ ___
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Defined in [codec/Option.ts:103](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Option.ts#L103)*
*Defined in [codec/Option.ts:103](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Option.ts#L103)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -166,7 +166,7 @@ ___
▸ **unwrap**(): `T`
*Defined in [codec/Option.ts:121](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Option.ts#L121)*
*Defined in [codec/Option.ts:121](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Option.ts#L121)*
*__description__*: Returns the value that the Option represents (if available)
@@ -179,7 +179,7 @@ ___
▸ **decodeOption**<`O`>(Type: *[Constructor](../modules/_types_.md#constructor)*, value?: *`any`*): [Codec](../interfaces/_types_.codec.md)
*Defined in [codec/Option.ts:26](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Option.ts#L26)*
*Defined in [codec/Option.ts:26](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Option.ts#L26)*
**Type parameters:**
@@ -200,7 +200,7 @@ ___
▸ **with**<`O`>(Type: *[Constructor](../modules/_types_.md#constructor)*): [Constructor](../modules/_types_.md#constructor)<[Option](_codec_option_.option.md)<`O`>>
*Defined in [codec/Option.ts:41](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Option.ts#L41)*
*Defined in [codec/Option.ts:41](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Option.ts#L41)*
**Type parameters:**
docs/types/classes/_codec_set_.set.html
+12 -12
View File
@@ -1974,7 +1974,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/db95340/packages/types/src/codec/Set.ts#L22" target="_blank">codec/Set.ts:22</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Set.ts#L22" target="_blank">codec/Set.ts:22</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2000,28 +2000,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/db95340/packages/types/src/codec/Set.ts#L72" target="_blank">codec/Set.ts:72</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Set.ts#L72" target="_blank">codec/Set.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>
<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/db95340/packages/types/src/codec/Set.ts#L79" target="_blank">codec/Set.ts:79</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Set.ts#L79" target="_blank">codec/Set.ts:79</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/db95340/packages/types/src/codec/Set.ts#L93" target="_blank">codec/Set.ts:93</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Set.ts#L93" target="_blank">codec/Set.ts:93</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/db95340/packages/types/src/codec/Set.ts#L86" target="_blank">codec/Set.ts:86</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Set.ts#L86" target="_blank">codec/Set.ts:86</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>
@@ -2030,7 +2030,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/db95340/packages/types/src/codec/Set.ts#L100" target="_blank">codec/Set.ts:100</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Set.ts#L100" target="_blank">codec/Set.ts:100</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>
@@ -2038,7 +2038,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/db95340/packages/types/src/codec/Set.ts#L107" target="_blank">codec/Set.ts:107</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Set.ts#L107" target="_blank">codec/Set.ts:107</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>
@@ -2046,14 +2046,14 @@
<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/db95340/packages/types/src/codec/Set.ts#L114" target="_blank">codec/Set.ts:114</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Set.ts#L114" target="_blank">codec/Set.ts:114</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/db95340/packages/types/src/codec/Set.ts#L122" target="_blank">codec/Set.ts:122</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Set.ts#L122" target="_blank">codec/Set.ts:122</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>
@@ -2077,7 +2077,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/db95340/packages/types/src/codec/Set.ts#L32" target="_blank">codec/Set.ts:32</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Set.ts#L32" target="_blank">codec/Set.ts:32</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2105,7 +2105,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/db95340/packages/types/src/codec/Set.ts#L63" target="_blank">codec/Set.ts:63</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Set.ts#L63" target="_blank">codec/Set.ts:63</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2170,7 +2170,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":"2018-12-21T12:22:17.727Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:45.559Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_codec_set_.set.md
+11 -11
View File
@@ -24,7 +24,7 @@
*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)*
*Defined in [codec/Set.ts:22](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Set.ts#L22)*
*Defined in [codec/Set.ts:22](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Set.ts#L22)*
**Parameters:**
@@ -45,7 +45,7 @@ ___
getencodedLength(): `number`
*Defined in [codec/Set.ts:72](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Set.ts#L72)*
*Defined in [codec/Set.ts:72](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Set.ts#L72)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -58,7 +58,7 @@ ___
getisEmpty(): `boolean`
*Defined in [codec/Set.ts:79](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Set.ts#L79)*
*Defined in [codec/Set.ts:79](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Set.ts#L79)*
*__description__*: true is the Set contains no values
@@ -71,7 +71,7 @@ ___
getvalueEncoded(): `number`
*Defined in [codec/Set.ts:93](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Set.ts#L93)*
*Defined in [codec/Set.ts:93](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Set.ts#L93)*
*__description__*: The encoded value for the set members
@@ -84,7 +84,7 @@ ___
getvalues(): `Array`<`string`>
*Defined in [codec/Set.ts:86](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Set.ts#L86)*
*Defined in [codec/Set.ts:86](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Set.ts#L86)*
*__description__*: The actual set values as a Array
@@ -102,7 +102,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/Set.ts:100](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Set.ts#L100)*
*Defined in [codec/Set.ts:100](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Set.ts#L100)*
*__description__*: Returns a hex string representation of the value
@@ -117,7 +117,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/Set.ts:107](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Set.ts#L107)*
*Defined in [codec/Set.ts:107](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Set.ts#L107)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -132,7 +132,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [codec/Set.ts:114](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Set.ts#L114)*
*Defined in [codec/Set.ts:114](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Set.ts#L114)*
*__description__*: Returns the string representation of the value
@@ -145,7 +145,7 @@ ___
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Defined in [codec/Set.ts:122](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Set.ts#L122)*
*Defined in [codec/Set.ts:122](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Set.ts#L122)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -164,7 +164,7 @@ ___
▸ **decodeSet**(setValues: *`SetValues`*, value?: * `Array`<`string`> &#124; `Uint8Array` &#124; `number`*): `Array`<`string`>
*Defined in [codec/Set.ts:32](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Set.ts#L32)*
*Defined in [codec/Set.ts:32](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Set.ts#L32)*
**Parameters:**
@@ -182,7 +182,7 @@ ___
▸ **encodeSet**(setValues: *`SetValues`*, value: *`Array`<`string`>*): `number`
*Defined in [codec/Set.ts:63](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Set.ts#L63)*
*Defined in [codec/Set.ts:63](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Set.ts#L63)*
**Parameters:**
docs/types/classes/_codec_struct_.struct.html
+12 -12
View File
@@ -2013,7 +2013,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L31" target="_blank">codec/Struct.ts:31</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2053,14 +2053,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/db95340/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/1e88075/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/db95340/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/1e88075/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>
@@ -2069,7 +2069,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/db95340/packages/types/src/codec/Struct.ts#L159" target="_blank">codec/Struct.ts:159</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L159" target="_blank">codec/Struct.ts:159</a></em></p>
<p><em><strong>description</strong></em>: Returns a specific names entry in the structure</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2093,7 +2093,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L166" target="_blank">codec/Struct.ts:166</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>
@@ -2115,7 +2115,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L173" target="_blank">codec/Struct.ts:173</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>
@@ -2123,7 +2123,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L180" target="_blank">codec/Struct.ts:180</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>
@@ -2131,7 +2131,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L187" target="_blank">codec/Struct.ts:187</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>
@@ -2139,14 +2139,14 @@
<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/db95340/packages/types/src/codec/Struct.ts#L201" target="_blank">codec/Struct.ts:201</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L201" target="_blank">codec/Struct.ts:201</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/db95340/packages/types/src/codec/Struct.ts#L209" target="_blank">codec/Struct.ts:209</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L209" target="_blank">codec/Struct.ts:209</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>
@@ -2170,7 +2170,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/db95340/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/1e88075/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>
@@ -2233,7 +2233,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":"2018-12-21T12:22:17.743Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:45.575Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_codec_struct_.struct.md
+11 -11
View File
@@ -97,7 +97,7 @@
⊕ **new Struct**(Types: *`S`*, value?: * `V` &#124; `Map`<`any`, `any`> &#124; `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/db95340/packages/types/src/codec/Struct.ts#L31)*
*Defined in [codec/Struct.ts:31](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L31)*
**Parameters:**
@@ -131,7 +131,7 @@ ___
getType(): `E`
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L142)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L142)*
*__description__*: Returns the Type description to sthe structure
@@ -144,7 +144,7 @@ ___
getencodedLength(): `number`
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L149)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L149)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -162,7 +162,7 @@ ___
*Overrides Map.get*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L159)*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L159)*
*__description__*: Returns a specific names entry in the structure
@@ -181,7 +181,7 @@ ___
▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md)
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L166)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -200,7 +200,7 @@ ___
▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)>
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L173)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L173)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -215,7 +215,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L180)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Returns a hex string representation of the value
@@ -230,7 +230,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L187)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L187)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -245,7 +245,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)*
*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L201)*
*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L201)*
*__description__*: Returns the string representation of the value
@@ -258,7 +258,7 @@ ___
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L209)*
*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L209)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -277,7 +277,7 @@ ___
▸ **with**<`S`>(Types: *`S`*): [Constructor](../modules/_types_.md#constructor)<[Struct](_codec_struct_.struct.md)<`S`>>
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L122)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L122)*
**Type parameters:**
docs/types/classes/_codec_tuple_.tuple.html
+12 -12
View File
@@ -1990,7 +1990,7 @@
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Tuple</strong>(Types: <em><code>S</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/db95340/packages/types/src/codec/Tuple.ts#L20" target="_blank">codec/Tuple.ts:20</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L20" target="_blank">codec/Tuple.ts:20</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2022,14 +2022,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/db95340/packages/types/src/codec/Tuple.ts#L65" target="_blank">codec/Tuple.ts:65</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L65" target="_blank">codec/Tuple.ts:65</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/db95340/packages/types/src/codec/Tuple.ts#L56" target="_blank">codec/Tuple.ts:56</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L56" target="_blank">codec/Tuple.ts:56</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>
@@ -2038,7 +2038,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/db95340/packages/types/src/codec/Tuple.ts#L121" target="_blank">codec/Tuple.ts:121</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L121" target="_blank">codec/Tuple.ts:121</a></em></p>
<p><em><strong>description</strong></em>: Filters the array with the callback</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2068,7 +2068,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/db95340/packages/types/src/codec/Tuple.ts#L130" target="_blank">codec/Tuple.ts:130</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L130" target="_blank">codec/Tuple.ts:130</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>
@@ -2099,7 +2099,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/db95340/packages/types/src/codec/Tuple.ts#L72" target="_blank">codec/Tuple.ts:72</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L72" target="_blank">codec/Tuple.ts:72</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>
@@ -2107,7 +2107,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/db95340/packages/types/src/codec/Tuple.ts#L79" target="_blank">codec/Tuple.ts:79</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L79" target="_blank">codec/Tuple.ts:79</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>
@@ -2115,7 +2115,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/db95340/packages/types/src/codec/Tuple.ts#L86" target="_blank">codec/Tuple.ts:86</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L86" target="_blank">codec/Tuple.ts:86</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>
@@ -2124,14 +2124,14 @@
<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/db95340/packages/types/src/codec/Tuple.ts#L95" target="_blank">codec/Tuple.ts:95</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L95" target="_blank">codec/Tuple.ts:95</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/db95340/packages/types/src/codec/Tuple.ts#L104" target="_blank">codec/Tuple.ts:104</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L104" target="_blank">codec/Tuple.ts:104</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>
@@ -2155,7 +2155,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_tuple_.tuple.html">Tuple</a>&lt;<code>S</code>&gt;&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L43" target="_blank">codec/Tuple.ts:43</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L43" target="_blank">codec/Tuple.ts:43</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="s---arrayconstructor">S : <code>Array</code>&lt;<a href="../modules/_types_.md#constructor">Constructor</a>&gt;</h4>
<p><strong>Parameters:</strong></p>
@@ -2218,7 +2218,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":"2018-12-21T12:22:17.767Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:45.607Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_codec_tuple_.tuple.md
+11 -11
View File
@@ -53,7 +53,7 @@
⊕ **new Tuple**(Types: *`S`*, value: *`any`*): [Tuple](_codec_tuple_.tuple.md)
*Defined in [codec/Tuple.ts:20](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L20)*
*Defined in [codec/Tuple.ts:20](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L20)*
**Parameters:**
@@ -86,7 +86,7 @@ ___
getTypes(): `Array`<`string`>
*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L65)*
*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L65)*
*__description__*: The types definition of the tuple
@@ -99,7 +99,7 @@ ___
getencodedLength(): `number`
*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L56)*
*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L56)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -117,7 +117,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L121)*
*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L121)*
*__description__*: Filters the array with the callback
@@ -139,7 +139,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L130)*
*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L130)*
*__description__*: Maps the array with the callback
@@ -162,7 +162,7 @@ ___
▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)>
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L72)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L72)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -177,7 +177,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L79)*
*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L79)*
*__description__*: Returns a hex string representation of the value
@@ -192,7 +192,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L86)*
*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L86)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -209,7 +209,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L95)*
*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L95)*
*__description__*: Returns the string representation of the value
@@ -222,7 +222,7 @@ ___
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L104)*
*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L104)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -241,7 +241,7 @@ ___
▸ **with**<`S`>(Types: *`S`*): [Constructor](../modules/_types_.md#constructor)<[Tuple](_codec_tuple_.tuple.md)<`S`>>
*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L43)*
*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L43)*
**Type parameters:**
docs/types/classes/_codec_typeregistry_.typeregistry.html
+5 -5
View File
@@ -1966,13 +1966,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/db95340/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/1e88075/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/db95340/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/1e88075/packages/types/src/codec/typeRegistry.ts#L51" target="_blank">codec/typeRegistry.ts:51</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -1994,7 +1994,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/db95340/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/1e88075/packages/types/src/codec/typeRegistry.ts#L20" target="_blank">codec/typeRegistry.ts:20</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2011,7 +2011,7 @@
</tbody>
</table>
<p><strong>Returns:</strong> <code>void</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/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/1e88075/packages/types/src/codec/typeRegistry.ts#L21" target="_blank">codec/typeRegistry.ts:21</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2076,7 +2076,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":"2018-12-21T12:22:17.944Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:45.767Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"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/db95340/packages/types/src/codec/typeRegistry.ts#L16)*
*Defined in [codec/typeRegistry.ts:16](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/typeRegistry.ts#L16)*
___
@@ -24,7 +24,7 @@ ___
▸ **get**(name: *`string`*): [Constructor](../modules/_types_.md#constructor) &#124; `undefined`
*Defined in [codec/typeRegistry.ts:51](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/typeRegistry.ts#L51)*
*Defined in [codec/typeRegistry.ts:51](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/codec/typeRegistry.ts#L20)*
*Defined in [codec/typeRegistry.ts:20](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/codec/typeRegistry.ts#L21)*
*Defined in [codec/typeRegistry.ts:21](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/typeRegistry.ts#L21)*
**Parameters:**
docs/types/classes/_codec_u8a_.u8a.html
+9 -9
View File
@@ -1979,7 +1979,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/db95340/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/1e88075/packages/types/src/codec/U8a.ts#L18" target="_blank">codec/U8a.ts:18</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2007,7 +2007,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/db95340/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/1e88075/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>
@@ -2015,7 +2015,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/db95340/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/1e88075/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2024,7 +2024,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/db95340/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</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>
@@ -2054,7 +2054,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/db95340/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</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>
@@ -2062,7 +2062,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/db95340/packages/types/src/codec/U8a.ts#L67" target="_blank">codec/U8a.ts:67</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L67" target="_blank">codec/U8a.ts:67</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>
@@ -2071,14 +2071,14 @@
<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/db95340/packages/types/src/codec/U8a.ts#L74" target="_blank">codec/U8a.ts:74</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L74" target="_blank">codec/U8a.ts:74</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/db95340/packages/types/src/codec/U8a.ts#L82" target="_blank">codec/U8a.ts:82</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L82" target="_blank">codec/U8a.ts:82</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>
@@ -2142,7 +2142,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":"2018-12-21T12:22:17.795Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:45.627Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_codec_u8a_.u8a.md
+8 -8
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/db95340/packages/types/src/codec/U8a.ts#L18)*
*Defined in [codec/U8a.ts:18](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -80,7 +80,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L43)*
*__description__*: The length of the value
@@ -98,7 +98,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -120,7 +120,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L60)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60)*
*__description__*: Returns a hex string representation of the value
@@ -135,7 +135,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L67)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L67)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -152,7 +152,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L74)*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L74)*
*__description__*: Returns the string representation of the value
@@ -165,7 +165,7 @@ ___
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L82)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L82)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_codec_u8afixed_.u8afixed.html
+10 -10
View File
@@ -1982,7 +1982,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/db95340/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/1e88075/packages/types/src/codec/U8aFixed.ts#L19" target="_blank">codec/U8aFixed.ts:19</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2047,7 +2047,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/db95340/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/1e88075/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>
@@ -2056,7 +2056,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/db95340/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/1e88075/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2071,7 +2071,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/db95340/packages/types/src/codec/U8aFixed.ts#L39" target="_blank">codec/U8aFixed.ts:39</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8aFixed.ts#L39" target="_blank">codec/U8aFixed.ts:39</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>
@@ -2738,7 +2738,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/db95340/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</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>
@@ -2769,7 +2769,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/db95340/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</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>
@@ -2778,7 +2778,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/db95340/packages/types/src/codec/U8a.ts#L67" target="_blank">codec/U8a.ts:67</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L67" target="_blank">codec/U8a.ts:67</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>
@@ -2796,7 +2796,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/db95340/packages/types/src/codec/U8a.ts#L74" target="_blank">codec/U8a.ts:74</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L74" target="_blank">codec/U8a.ts:74</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>
@@ -2804,7 +2804,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>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/db95340/packages/types/src/codec/U8a.ts#L82" target="_blank">codec/U8a.ts:82</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L82" target="_blank">codec/U8a.ts:82</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>
@@ -2876,7 +2876,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":"2018-12-21T12:22:17.899Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:45.727Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_codec_u8afixed_.u8afixed.md
+9 -9
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/db95340/packages/types/src/codec/U8aFixed.ts#L19)*
*Defined in [codec/U8aFixed.ts:19](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8aFixed.ts#L19)*
**Parameters:**
@@ -128,7 +128,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -145,7 +145,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L43)*
*__description__*: The length of the value
@@ -174,7 +174,7 @@ ___
▸ **bitLength**(): `number`
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8aFixed.ts#L39)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8aFixed.ts#L39)*
*__description__*: Returns the number of bits in the value
@@ -700,7 +700,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -724,7 +724,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L60)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60)*
*__description__*: Returns a hex string representation of the value
@@ -741,7 +741,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L67)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L67)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -775,7 +775,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L74)*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L74)*
*__description__*: Returns the string representation of the value
@@ -790,7 +790,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L82)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L82)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_codec_uint_.uint.html
+4 -4
View File
@@ -1980,7 +1980,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/db95340/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/1e88075/packages/types/src/codec/UInt.ts#L21" target="_blank">codec/UInt.ts:21</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2016,7 +2016,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/db95340/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/1e88075/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>
@@ -2024,7 +2024,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>Overrides AbstractInt.toU8a</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/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/1e88075/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>
@@ -2088,7 +2088,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":"2018-12-21T12:22:17.907Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:45.731Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"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/db95340/packages/types/src/codec/UInt.ts#L21)*
*Defined in [codec/UInt.ts:21](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/codec/UInt.ts#L36)*
*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/UInt.ts#L36)*
*__description__*: Returns a hex string representation of the value
@@ -77,7 +77,7 @@ ___
*Overrides AbstractInt.toU8a*
*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/UInt.ts#L48)*
*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1e88075/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
+14 -14
View File
@@ -1980,7 +1980,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/db95340/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/1e88075/packages/types/src/codec/Vector.ts#L22" target="_blank">codec/Vector.ts:22</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2015,13 +2015,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/db95340/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/1e88075/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/db95340/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/1e88075/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>
@@ -2029,7 +2029,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/db95340/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/1e88075/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>
@@ -2038,7 +2038,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/db95340/packages/types/src/codec/Vector.ts#L139" target="_blank">codec/Vector.ts:139</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L139" target="_blank">codec/Vector.ts:139</a></em></p>
<p><em><strong>description</strong></em>: Filters the array with the callback</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2068,7 +2068,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/db95340/packages/types/src/codec/Vector.ts#L148" target="_blank">codec/Vector.ts:148</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L148" target="_blank">codec/Vector.ts:148</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>
@@ -2099,7 +2099,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/db95340/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/1e88075/packages/types/src/codec/Vector.ts#L81" target="_blank">codec/Vector.ts:81</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>
@@ -2107,7 +2107,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/db95340/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/1e88075/packages/types/src/codec/Vector.ts#L88" target="_blank">codec/Vector.ts:88</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>
@@ -2115,7 +2115,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/db95340/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/1e88075/packages/types/src/codec/Vector.ts#L95" target="_blank">codec/Vector.ts:95</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>
@@ -2124,14 +2124,14 @@
<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/db95340/packages/types/src/codec/Vector.ts#L104" target="_blank">codec/Vector.ts:104</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L104" target="_blank">codec/Vector.ts:104</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/db95340/packages/types/src/codec/Vector.ts#L117" target="_blank">codec/Vector.ts:117</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L117" target="_blank">codec/Vector.ts:117</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>
@@ -2155,7 +2155,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/db95340/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/1e88075/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>
@@ -2182,7 +2182,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/db95340/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/1e88075/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>
@@ -2245,7 +2245,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":"2018-12-21T12:22:17.940Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:45.767Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_codec_vector_.vector.md
+13 -13
View File
@@ -33,7 +33,7 @@
⊕ **new Vector**(Type: *[Constructor](../modules/_types_.md#constructor)<`T`>*, value?: * [Vector](_codec_vector_.vector.md)<`any`> &#124; `Uint8Array` &#124; `string` &#124; `Array`<`any`>*): [Vector](_codec_vector_.vector.md)
*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L22)*
*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/codec/Vector.ts#L57)*
*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/codec/Vector.ts#L64)*
*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/codec/Vector.ts#L73)*
*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L73)*
*__description__*: The length of the value
@@ -110,7 +110,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L139)*
*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L139)*
*__description__*: Filters the array with the callback
@@ -132,7 +132,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L148)*
*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L148)*
*__description__*: Maps the array with the callback
@@ -155,7 +155,7 @@ ___
▸ **toArray**(): `Array`<`T`>
*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L81)*
*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L81)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -170,7 +170,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)*
*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L88)*
*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L88)*
*__description__*: Returns a hex string representation of the value
@@ -185,7 +185,7 @@ ___
*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)*
*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L95)*
*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L95)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -202,7 +202,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L104)*
*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L104)*
*__description__*: Returns the string representation of the value
@@ -215,7 +215,7 @@ ___
▸ **toU8a**(isBare?: * `undefined` &#124; `false` &#124; `true`*): `Uint8Array`
*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L117)*
*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L117)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -234,7 +234,7 @@ ___
▸ **decodeVector**<`T`>(Type: *[Constructor](../modules/_types_.md#constructor)<`T`>*, value: * [Vector](_codec_vector_.vector.md)<`any`> &#124; `Uint8Array` &#124; `string` &#124; `Array`<`any`>*): `Array`<`T`>
*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L32)*
*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L32)*
**Type parameters:**
@@ -255,7 +255,7 @@ ___
▸ **with**<`O`>(Type: *[Constructor](../modules/_types_.md#constructor)<`O`>*): [Constructor](../modules/_types_.md#constructor)<[Vector](_codec_vector_.vector.md)<`O`>>
*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L49)*
*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L49)*
**Type parameters:**
docs/types/classes/_data_.data.html
+9 -9
View File
@@ -1976,7 +1976,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/db95340/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/1e88075/packages/types/src/codec/U8a.ts#L18" target="_blank">codec/U8a.ts:18</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2034,7 +2034,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/db95340/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/1e88075/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>
@@ -2043,7 +2043,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/db95340/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/1e88075/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2718,7 +2718,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/db95340/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</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>
@@ -2749,7 +2749,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/db95340/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</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>
@@ -2758,7 +2758,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/db95340/packages/types/src/codec/U8a.ts#L67" target="_blank">codec/U8a.ts:67</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L67" target="_blank">codec/U8a.ts:67</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>
@@ -2776,7 +2776,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/db95340/packages/types/src/codec/U8a.ts#L74" target="_blank">codec/U8a.ts:74</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L74" target="_blank">codec/U8a.ts:74</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>
@@ -2784,7 +2784,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>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/db95340/packages/types/src/codec/U8a.ts#L82" target="_blank">codec/U8a.ts:82</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L82" target="_blank">codec/U8a.ts:82</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>
@@ -2856,7 +2856,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":"2018-12-21T12:22:07.486Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:34.906Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_data_.data.md
+8 -8
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/db95340/packages/types/src/codec/U8a.ts#L18)*
*Defined in [codec/U8a.ts:18](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L18)*
**Parameters:**
@@ -115,7 +115,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -132,7 +132,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L43)*
*__description__*: The length of the value
@@ -674,7 +674,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -698,7 +698,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L60)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60)*
*__description__*: Returns a hex string representation of the value
@@ -715,7 +715,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L67)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L67)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -749,7 +749,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L74)*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L74)*
*__description__*: Returns the string representation of the value
@@ -764,7 +764,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L82)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L82)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_digest_.authoritieschange.html
+14 -14
View File
@@ -1978,7 +1978,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/db95340/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/1e88075/packages/types/src/codec/Vector.ts#L22" target="_blank">codec/Vector.ts:22</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2008,14 +2008,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/db95340/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/1e88075/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/db95340/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/1e88075/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>
@@ -2024,7 +2024,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/db95340/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/1e88075/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>
@@ -2205,7 +2205,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/db95340/packages/types/src/codec/Vector.ts#L139" target="_blank">codec/Vector.ts:139</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L139" target="_blank">codec/Vector.ts:139</a></em></p>
<p><em><strong>description</strong></em>: Filters the array with the callback</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2758,7 +2758,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/db95340/packages/types/src/codec/Vector.ts#L148" target="_blank">codec/Vector.ts:148</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L148" target="_blank">codec/Vector.ts:148</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>
@@ -3140,7 +3140,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/db95340/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/1e88075/packages/types/src/codec/Vector.ts#L81" target="_blank">codec/Vector.ts:81</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>
@@ -3149,7 +3149,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/db95340/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/1e88075/packages/types/src/codec/Vector.ts#L88" target="_blank">codec/Vector.ts:88</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>
@@ -3158,7 +3158,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/db95340/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/1e88075/packages/types/src/codec/Vector.ts#L95" target="_blank">codec/Vector.ts:95</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>
@@ -3176,7 +3176,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/db95340/packages/types/src/codec/Vector.ts#L104" target="_blank">codec/Vector.ts:104</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L104" target="_blank">codec/Vector.ts:104</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>
@@ -3184,7 +3184,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>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/db95340/packages/types/src/codec/Vector.ts#L117" target="_blank">codec/Vector.ts:117</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L117" target="_blank">codec/Vector.ts:117</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>
@@ -3242,7 +3242,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/db95340/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/1e88075/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>
@@ -3270,7 +3270,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/db95340/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/1e88075/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>
@@ -3333,7 +3333,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":"2018-12-21T12:22:07.690Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:35.426Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_digest_.authoritieschange.md
+13 -13
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/db95340/packages/types/src/codec/Vector.ts#L22)*
*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/codec/Vector.ts#L57)*
*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/codec/Vector.ts#L64)*
*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/codec/Vector.ts#L73)*
*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L73)*
*__description__*: The length of the value
@@ -252,7 +252,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L139)*
*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L139)*
*__description__*: Filters the array with the callback
@@ -672,7 +672,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L148)*
*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L148)*
*__description__*: Maps the array with the callback
@@ -980,7 +980,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)*
*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L81)*
*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L81)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -997,7 +997,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)*
*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L88)*
*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L88)*
*__description__*: Returns a hex string representation of the value
@@ -1014,7 +1014,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)*
*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L95)*
*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L95)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1048,7 +1048,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L104)*
*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L104)*
*__description__*: Returns the string representation of the value
@@ -1063,7 +1063,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)*
*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L117)*
*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L117)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1120,7 +1120,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[decodeVector](_codec_vector_.vector.md#decodevector)*
*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L32)*
*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L32)*
**Type parameters:**
@@ -1143,7 +1143,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)*
*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L49)*
*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L49)*
**Type parameters:**
docs/types/classes/_digest_.changestrieroot.html
+10 -10
View File
@@ -1977,7 +1977,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/db95340/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/1e88075/packages/types/src/H256.ts#L15" target="_blank">H256.ts:15</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2035,7 +2035,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/db95340/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/1e88075/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>
@@ -2044,7 +2044,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/db95340/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/1e88075/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2060,7 +2060,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/db95340/packages/types/src/codec/U8aFixed.ts#L39" target="_blank">codec/U8aFixed.ts:39</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8aFixed.ts#L39" target="_blank">codec/U8aFixed.ts:39</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>
@@ -2727,7 +2727,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/db95340/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</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>
@@ -2758,7 +2758,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/db95340/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</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>
@@ -2767,7 +2767,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/db95340/packages/types/src/codec/U8a.ts#L67" target="_blank">codec/U8a.ts:67</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L67" target="_blank">codec/U8a.ts:67</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>
@@ -2785,7 +2785,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/db95340/packages/types/src/codec/U8a.ts#L74" target="_blank">codec/U8a.ts:74</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L74" target="_blank">codec/U8a.ts:74</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>
@@ -2793,7 +2793,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>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/db95340/packages/types/src/codec/U8a.ts#L82" target="_blank">codec/U8a.ts:82</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L82" target="_blank">codec/U8a.ts:82</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>
@@ -2865,7 +2865,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":"2018-12-21T12:22:07.834Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:35.566Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_digest_.changestrieroot.md
+9 -9
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/db95340/packages/types/src/H256.ts#L15)*
*Defined in [H256.ts:15](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/H256.ts#L15)*
**Parameters:**
@@ -117,7 +117,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -134,7 +134,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L43)*
*__description__*: The length of the value
@@ -165,7 +165,7 @@ ___
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8aFixed.ts#L39)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8aFixed.ts#L39)*
*__description__*: Returns the number of bits in the value
@@ -691,7 +691,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -715,7 +715,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L60)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60)*
*__description__*: Returns a hex string representation of the value
@@ -732,7 +732,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L67)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L67)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -766,7 +766,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L74)*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L74)*
*__description__*: Returns the string representation of the value
@@ -781,7 +781,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L82)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L82)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_digest_.digest.html
+13 -13
View File
@@ -1979,7 +1979,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/db95340/packages/types/src/Digest.ts#L89" target="_blank">Digest.ts:89</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Digest.ts#L89" target="_blank">Digest.ts:89</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2015,7 +2015,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/db95340/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/1e88075/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>
@@ -2023,14 +2023,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/db95340/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/1e88075/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/db95340/packages/types/src/Digest.ts#L99" target="_blank">Digest.ts:99</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Digest.ts#L99" target="_blank">Digest.ts:99</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>
@@ -2111,7 +2111,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/db95340/packages/types/src/codec/Struct.ts#L159" target="_blank">codec/Struct.ts:159</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L159" target="_blank">codec/Struct.ts:159</a></em></p>
<p><em><strong>description</strong></em>: Returns a specific names entry in the structure</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2136,7 +2136,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L166" target="_blank">codec/Struct.ts:166</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>
@@ -2215,7 +2215,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L173" target="_blank">codec/Struct.ts:173</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>
@@ -2224,7 +2224,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L180" target="_blank">codec/Struct.ts:180</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>
@@ -2233,7 +2233,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L187" target="_blank">codec/Struct.ts:187</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>
@@ -2242,7 +2242,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/db95340/packages/types/src/codec/Struct.ts#L201" target="_blank">codec/Struct.ts:201</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L201" target="_blank">codec/Struct.ts:201</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>
@@ -2250,7 +2250,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>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/db95340/packages/types/src/codec/Struct.ts#L209" target="_blank">codec/Struct.ts:209</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L209" target="_blank">codec/Struct.ts:209</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>
@@ -2283,7 +2283,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/db95340/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/1e88075/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>
@@ -2346,7 +2346,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":"2018-12-21T12:22:07.870Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:35.622Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_digest_.digest.md
+12 -12
View File
@@ -29,7 +29,7 @@
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Digest.ts:89](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Digest.ts#L89)*
*Defined in [Digest.ts:89](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Digest.ts#L89)*
**Parameters:**
@@ -76,7 +76,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L142)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L142)*
*__description__*: Returns the Type description to sthe structure
@@ -91,7 +91,7 @@ getencodedLength(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L149)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L149)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -104,7 +104,7 @@ ___
getlogs(): [Vector](_codec_vector_.vector.md)<[DigestItem](_digest_.digestitem.md)>
*Defined in [Digest.ts:99](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Digest.ts#L99)*
*Defined in [Digest.ts:99](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Digest.ts#L99)*
*__description__*: The [DigestItem](_digest_.digestitem.md) logs
@@ -206,7 +206,7 @@ ___
*Overrides Map.get*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L159)*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L159)*
*__description__*: Returns a specific names entry in the structure
@@ -227,7 +227,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L166)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -302,7 +302,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L173)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L173)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -319,7 +319,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L180)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Returns a hex string representation of the value
@@ -336,7 +336,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L187)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L187)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -353,7 +353,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L201)*
*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L201)*
*__description__*: Returns the string representation of the value
@@ -368,7 +368,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L209)*
*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L209)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -404,7 +404,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L122)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L122)*
**Type parameters:**
docs/types/classes/_digest_.digestitem.html
+12 -12
View File
@@ -1974,7 +1974,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/db95340/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/1e88075/packages/types/src/Digest.ts#L73" target="_blank">Digest.ts:73</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -1997,7 +1997,7 @@
<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/db95340/packages/types/src/codec/EnumType.ts#L97" target="_blank">codec/EnumType.ts:97</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L97" target="_blank">codec/EnumType.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>
@@ -2005,7 +2005,7 @@
<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/db95340/packages/types/src/codec/EnumType.ts#L104" target="_blank">codec/EnumType.ts:104</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L104" target="_blank">codec/EnumType.ts:104</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>
@@ -2013,7 +2013,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/db95340/packages/types/src/codec/EnumType.ts#L111" target="_blank">codec/EnumType.ts:111</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L111" target="_blank">codec/EnumType.ts:111</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>
@@ -2021,7 +2021,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/db95340/packages/types/src/codec/EnumType.ts#L118" target="_blank">codec/EnumType.ts:118</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L118" target="_blank">codec/EnumType.ts:118</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>
@@ -2029,7 +2029,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/db95340/packages/types/src/codec/EnumType.ts#L125" target="_blank">codec/EnumType.ts:125</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L125" target="_blank">codec/EnumType.ts:125</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>
@@ -2039,7 +2039,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/db95340/packages/types/src/codec/EnumType.ts#L132" target="_blank">codec/EnumType.ts:132</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L132" target="_blank">codec/EnumType.ts:132</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>
@@ -2048,7 +2048,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/db95340/packages/types/src/codec/EnumType.ts#L139" target="_blank">codec/EnumType.ts:139</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L139" target="_blank">codec/EnumType.ts:139</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>
@@ -2056,7 +2056,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/db95340/packages/types/src/codec/EnumType.ts#L146" target="_blank">codec/EnumType.ts:146</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L146" target="_blank">codec/EnumType.ts:146</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>
@@ -2065,7 +2065,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/db95340/packages/types/src/codec/EnumType.ts#L153" target="_blank">codec/EnumType.ts:153</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L153" target="_blank">codec/EnumType.ts:153</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>
@@ -2073,7 +2073,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>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/db95340/packages/types/src/codec/EnumType.ts#L161" target="_blank">codec/EnumType.ts:161</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L161" target="_blank">codec/EnumType.ts:161</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>
@@ -2137,7 +2137,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":"2018-12-21T12:22:07.898Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:35.650Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_digest_.digestitem.md
+11 -11
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/db95340/packages/types/src/Digest.ts#L73)*
*Defined in [Digest.ts:73](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Digest.ts#L73)*
**Parameters:**
@@ -46,7 +46,7 @@ getencodedLength(): `number`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)*
*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L97)*
*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L97)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -61,7 +61,7 @@ getisNone(): `boolean`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)*
*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L104)*
*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L104)*
*__description__*: Checks if the Enum points to a [Null](_null_.null.md) type
@@ -76,7 +76,7 @@ getisNull(): `boolean`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)*
*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L111)*
*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L111)*
*__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone)
@@ -91,7 +91,7 @@ gettype(): `string`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)*
*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L118)*
*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L118)*
*__description__*: The name of the type this enum value represents
@@ -106,7 +106,7 @@ getvalue(): [Codec](../interfaces/_types_.codec.md)
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)*
*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L125)*
*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L125)*
*__description__*: The value of the enum
@@ -126,7 +126,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)*
*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L132)*
*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L132)*
*__description__*: Returns a hex string representation of the value
@@ -143,7 +143,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)*
*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L139)*
*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L139)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -158,7 +158,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)*
*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L146)*
*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L146)*
*__description__*: Returns the number representation for the value
@@ -175,7 +175,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)*
*Defined in [codec/EnumType.ts:153](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L153)*
*Defined in [codec/EnumType.ts:153](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L153)*
*__description__*: Returns the string representation of the value
@@ -190,7 +190,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)*
*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L161)*
*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L161)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_digest_.other.html
+9 -9
View File
@@ -1977,7 +1977,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/db95340/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/1e88075/packages/types/src/Bytes.ts#L18" target="_blank">Bytes.ts:18</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2036,7 +2036,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/db95340/packages/types/src/Bytes.ts#L64" target="_blank">Bytes.ts:64</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bytes.ts#L64" target="_blank">Bytes.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>
@@ -2045,7 +2045,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/db95340/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/1e88075/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2720,7 +2720,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/db95340/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</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>
@@ -2751,7 +2751,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/db95340/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</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>
@@ -2760,7 +2760,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/db95340/packages/types/src/codec/U8a.ts#L67" target="_blank">codec/U8a.ts:67</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L67" target="_blank">codec/U8a.ts:67</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>
@@ -2778,7 +2778,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/db95340/packages/types/src/codec/U8a.ts#L74" target="_blank">codec/U8a.ts:74</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L74" target="_blank">codec/U8a.ts:74</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>
@@ -2787,7 +2787,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em> <code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></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/db95340/packages/types/src/Bytes.ts#L72" target="_blank">Bytes.ts:72</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bytes.ts#L72" target="_blank">Bytes.ts:72</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>
@@ -2859,7 +2859,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":"2018-12-21T12:22:08.026Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:35.790Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_digest_.other.md
+8 -8
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/db95340/packages/types/src/Bytes.ts#L18)*
*Defined in [Bytes.ts:18](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bytes.ts#L18)*
**Parameters:**
@@ -119,7 +119,7 @@ getencodedLength(): `number`
*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Bytes.ts#L64)*
*Defined in [Bytes.ts:64](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bytes.ts#L64)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -136,7 +136,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L43)*
*__description__*: The length of the value
@@ -678,7 +678,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -702,7 +702,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L60)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60)*
*__description__*: Returns a hex string representation of the value
@@ -719,7 +719,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L67)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L67)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -753,7 +753,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L74)*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L74)*
*__description__*: Returns the string representation of the value
@@ -770,7 +770,7 @@ ___
*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Bytes.ts#L72)*
*Defined in [Bytes.ts:72](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Bytes.ts#L72)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_digest_.seal.html
+14 -14
View File
@@ -1978,7 +1978,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/db95340/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/1e88075/packages/types/src/Digest.ts#L44" target="_blank">Digest.ts:44</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2009,7 +2009,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/db95340/packages/types/src/codec/Tuple.ts#L65" target="_blank">codec/Tuple.ts:65</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L65" target="_blank">codec/Tuple.ts:65</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>
@@ -2017,21 +2017,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/db95340/packages/types/src/codec/Tuple.ts#L56" target="_blank">codec/Tuple.ts:56</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L56" target="_blank">codec/Tuple.ts:56</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/db95340/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/1e88075/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/db95340/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/1e88075/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>
@@ -2212,7 +2212,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/db95340/packages/types/src/codec/Tuple.ts#L121" target="_blank">codec/Tuple.ts:121</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L121" target="_blank">codec/Tuple.ts:121</a></em></p>
<p><em><strong>description</strong></em>: Filters the array with the callback</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2765,7 +2765,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/db95340/packages/types/src/codec/Tuple.ts#L130" target="_blank">codec/Tuple.ts:130</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L130" target="_blank">codec/Tuple.ts:130</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>
@@ -3147,7 +3147,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/db95340/packages/types/src/codec/Tuple.ts#L72" target="_blank">codec/Tuple.ts:72</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L72" target="_blank">codec/Tuple.ts:72</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>
@@ -3156,7 +3156,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/db95340/packages/types/src/codec/Tuple.ts#L79" target="_blank">codec/Tuple.ts:79</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L79" target="_blank">codec/Tuple.ts:79</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>
@@ -3165,7 +3165,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/db95340/packages/types/src/codec/Tuple.ts#L86" target="_blank">codec/Tuple.ts:86</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L86" target="_blank">codec/Tuple.ts:86</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>
@@ -3183,7 +3183,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/db95340/packages/types/src/codec/Tuple.ts#L95" target="_blank">codec/Tuple.ts:95</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L95" target="_blank">codec/Tuple.ts:95</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>
@@ -3191,7 +3191,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>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/db95340/packages/types/src/codec/Tuple.ts#L104" target="_blank">codec/Tuple.ts:104</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L104" target="_blank">codec/Tuple.ts:104</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>
@@ -3249,7 +3249,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_tuple_.tuple.html">Tuple</a>&lt;<code>S</code>&gt;&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/db95340/packages/types/src/codec/Tuple.ts#L43" target="_blank">codec/Tuple.ts:43</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L43" target="_blank">codec/Tuple.ts:43</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="s---arrayconstructor">S : <code>Array</code>&lt;<a href="../modules/_types_.md#constructor">Constructor</a>&gt;</h4>
<p><strong>Parameters:</strong></p>
@@ -3312,7 +3312,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":"2018-12-21T12:22:08.227Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:36.002Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_digest_.seal.md
+13 -13
View File
@@ -29,7 +29,7 @@
*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [Digest.ts:44](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Digest.ts#L44)*
*Defined in [Digest.ts:44](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Digest.ts#L44)*
**Parameters:**
@@ -67,7 +67,7 @@ getTypes(): `Array`<`string`>
*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)*
*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L65)*
*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L65)*
*__description__*: The types definition of the tuple
@@ -82,7 +82,7 @@ getencodedLength(): `number`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)*
*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L56)*
*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L56)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -95,7 +95,7 @@ ___
getsignature(): [Signature](_signature_.signature.md)
*Defined in [Digest.ts:55](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Digest.ts#L55)*
*Defined in [Digest.ts:55](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Digest.ts#L55)*
*__description__*: The wrapped [Signature](_signature_.signature.md)
@@ -108,7 +108,7 @@ ___
getslot(): [U64](_u64_.u64.md)
*Defined in [Digest.ts:62](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Digest.ts#L62)*
*Defined in [Digest.ts:62](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Digest.ts#L62)*
*__description__*: The wrapped [U64](_u64_.u64.md) slot
@@ -278,7 +278,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L121)*
*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L121)*
*__description__*: Filters the array with the callback
@@ -698,7 +698,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L130)*
*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L130)*
*__description__*: Maps the array with the callback
@@ -1006,7 +1006,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L72)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L72)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -1023,7 +1023,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)*
*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L79)*
*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L79)*
*__description__*: Returns a hex string representation of the value
@@ -1040,7 +1040,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L86)*
*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L86)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1074,7 +1074,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L95)*
*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L95)*
*__description__*: Returns the string representation of the value
@@ -1089,7 +1089,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)*
*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L104)*
*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L104)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1146,7 +1146,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L43)*
*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L43)*
**Type parameters:**
docs/types/classes/_event_.event.html
+20 -20
View File
@@ -1979,7 +1979,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new Event</strong>(<em>value: <em><code>Uint8Array</code></em>): [Event](_event</em>.event.md)</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/db95340/packages/types/src/Event.ts#L85" target="_blank">Event.ts:85</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L85" target="_blank">Event.ts:85</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2015,14 +2015,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/db95340/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/1e88075/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/db95340/packages/types/src/Event.ts#L138" target="_blank">Event.ts:138</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L138" target="_blank">Event.ts:138</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>
@@ -2030,42 +2030,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/db95340/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/1e88075/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/db95340/packages/types/src/Event.ts#L145" target="_blank">Event.ts:145</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L145" target="_blank">Event.ts:145</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/db95340/packages/types/src/Event.ts#L152" target="_blank">Event.ts:152</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L152" target="_blank">Event.ts:152</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>
<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/db95340/packages/types/src/Event.ts#L159" target="_blank">Event.ts:159</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L159" target="_blank">Event.ts:159</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/db95340/packages/types/src/Event.ts#L166" target="_blank">Event.ts:166</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L166" target="_blank">Event.ts:166</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/db95340/packages/types/src/Event.ts#L173" target="_blank">Event.ts:173</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L173" target="_blank">Event.ts:173</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>
@@ -2146,7 +2146,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/db95340/packages/types/src/codec/Struct.ts#L159" target="_blank">codec/Struct.ts:159</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L159" target="_blank">codec/Struct.ts:159</a></em></p>
<p><em><strong>description</strong></em>: Returns a specific names entry in the structure</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2171,7 +2171,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L166" target="_blank">codec/Struct.ts:166</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>
@@ -2250,7 +2250,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L173" target="_blank">codec/Struct.ts:173</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>
@@ -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_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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L180" target="_blank">codec/Struct.ts:180</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_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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L187" target="_blank">codec/Struct.ts:187</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>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/db95340/packages/types/src/codec/Struct.ts#L201" target="_blank">codec/Struct.ts:201</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L201" target="_blank">codec/Struct.ts:201</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>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/db95340/packages/types/src/codec/Struct.ts#L209" target="_blank">codec/Struct.ts:209</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L209" target="_blank">codec/Struct.ts:209</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>
@@ -2317,7 +2317,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></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Event.ts#L97" target="_blank">Event.ts:97</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L97" target="_blank">Event.ts:97</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2338,7 +2338,7 @@
<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/db95340/packages/types/src/Event.ts#L116" target="_blank">Event.ts:116</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L116" target="_blank">Event.ts:116</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2360,7 +2360,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/db95340/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/1e88075/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>
@@ -2423,7 +2423,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":"2018-12-21T12:22:08.299Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:36.070Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_event_.event.md
+19 -19
View File
@@ -29,7 +29,7 @@
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [Event.ts:85](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Event.ts#L85)*
*Defined in [Event.ts:85](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L85)*
**Parameters:**
@@ -76,7 +76,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L142)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L142)*
*__description__*: Returns the Type description to sthe structure
@@ -89,7 +89,7 @@ ___
getdata(): [EventData](_event_.eventdata.md)
*Defined in [Event.ts:138](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Event.ts#L138)*
*Defined in [Event.ts:138](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L138)*
*__description__*: The wrapped [EventData](_event_.eventdata.md)
@@ -104,7 +104,7 @@ getencodedLength(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L149)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L149)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -117,7 +117,7 @@ ___
getindex(): [EventIndex](_event_.eventindex.md)
*Defined in [Event.ts:145](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Event.ts#L145)*
*Defined in [Event.ts:145](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L145)*
*__description__*: The [EventIndex](_event_.eventindex.md), identifying the raw event
@@ -130,7 +130,7 @@ ___
getmeta(): [EventMetadata](_metadata_events_.eventmetadata.md)
*Defined in [Event.ts:152](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Event.ts#L152)*
*Defined in [Event.ts:152](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L152)*
*__description__*: The [EventMetadata](_metadata_events_.eventmetadata.md) with the documentation
@@ -143,7 +143,7 @@ ___
getmethod(): `string`
*Defined in [Event.ts:159](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Event.ts#L159)*
*Defined in [Event.ts:159](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L159)*
*__description__*: The method string identifying the event
@@ -156,7 +156,7 @@ ___
getsection(): `string`
*Defined in [Event.ts:166](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Event.ts#L166)*
*Defined in [Event.ts:166](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L166)*
*__description__*: The section string identifying the event
@@ -169,7 +169,7 @@ ___
gettypeDef(): `Array`<[TypeDef](../modules/_types_.md#typedef)>
*Defined in [Event.ts:173](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Event.ts#L173)*
*Defined in [Event.ts:173](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L173)*
*__description__*: The [TypeDef](../modules/_types_.md#typedef) for the event
@@ -271,7 +271,7 @@ ___
*Overrides Map.get*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L159)*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L159)*
*__description__*: Returns a specific names entry in the structure
@@ -292,7 +292,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L166)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -367,7 +367,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L173)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L173)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -384,7 +384,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L180)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Returns a hex string representation of the value
@@ -401,7 +401,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L187)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L187)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -418,7 +418,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L201)*
*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L201)*
*__description__*: Returns the string representation of the value
@@ -433,7 +433,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L209)*
*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L209)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -467,7 +467,7 @@ ___
▸ **decodeEvent**(value: *`Uint8Array`*): `object`
*Defined in [Event.ts:97](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Event.ts#L97)*
*Defined in [Event.ts:97](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L97)*
**Parameters:**
@@ -484,7 +484,7 @@ ___
▸ **injectMetadata**(metadata: *[Metadata](_metadata_index_.metadata.md)*): `void`
*Defined in [Event.ts:116](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Event.ts#L116)*
*Defined in [Event.ts:116](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L116)*
**Parameters:**
@@ -503,7 +503,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L122)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L122)*
**Type parameters:**
docs/types/classes/_event_.eventdata.html
+16 -16
View File
@@ -1978,7 +1978,7 @@
<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><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/db95340/packages/types/src/Event.ts#L27" target="_blank">Event.ts:27</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L27" target="_blank">Event.ts:27</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2029,7 +2029,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/db95340/packages/types/src/codec/Tuple.ts#L65" target="_blank">codec/Tuple.ts:65</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L65" target="_blank">codec/Tuple.ts:65</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>
@@ -2037,35 +2037,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/db95340/packages/types/src/codec/Tuple.ts#L56" target="_blank">codec/Tuple.ts:56</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L56" target="_blank">codec/Tuple.ts:56</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/db95340/packages/types/src/Event.ts#L41" target="_blank">Event.ts:41</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L41" target="_blank">Event.ts:41</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>
<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/db95340/packages/types/src/Event.ts#L48" target="_blank">Event.ts:48</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L48" target="_blank">Event.ts:48</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/db95340/packages/types/src/Event.ts#L55" target="_blank">Event.ts:55</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L55" target="_blank">Event.ts:55</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/db95340/packages/types/src/Event.ts#L62" target="_blank">Event.ts:62</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L62" target="_blank">Event.ts:62</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>
@@ -2246,7 +2246,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/db95340/packages/types/src/codec/Tuple.ts#L121" target="_blank">codec/Tuple.ts:121</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L121" target="_blank">codec/Tuple.ts:121</a></em></p>
<p><em><strong>description</strong></em>: Filters the array with the callback</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2799,7 +2799,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/db95340/packages/types/src/codec/Tuple.ts#L130" target="_blank">codec/Tuple.ts:130</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L130" target="_blank">codec/Tuple.ts:130</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>
@@ -3181,7 +3181,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/db95340/packages/types/src/codec/Tuple.ts#L72" target="_blank">codec/Tuple.ts:72</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L72" target="_blank">codec/Tuple.ts:72</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>
@@ -3190,7 +3190,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/db95340/packages/types/src/codec/Tuple.ts#L79" target="_blank">codec/Tuple.ts:79</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L79" target="_blank">codec/Tuple.ts:79</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>
@@ -3199,7 +3199,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/db95340/packages/types/src/codec/Tuple.ts#L86" target="_blank">codec/Tuple.ts:86</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L86" target="_blank">codec/Tuple.ts:86</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>
@@ -3217,7 +3217,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/db95340/packages/types/src/codec/Tuple.ts#L95" target="_blank">codec/Tuple.ts:95</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L95" target="_blank">codec/Tuple.ts:95</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>
@@ -3225,7 +3225,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>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/db95340/packages/types/src/codec/Tuple.ts#L104" target="_blank">codec/Tuple.ts:104</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L104" target="_blank">codec/Tuple.ts:104</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>
@@ -3283,7 +3283,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_tuple_.tuple.html">Tuple</a>&lt;<code>S</code>&gt;&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/db95340/packages/types/src/codec/Tuple.ts#L43" target="_blank">codec/Tuple.ts:43</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L43" target="_blank">codec/Tuple.ts:43</a></em></p>
<p><strong>Type parameters:</strong></p>
<h4 id="s---arrayconstructor">S : <code>Array</code>&lt;<a href="../modules/_types_.md#constructor">Constructor</a>&gt;</h4>
<p><strong>Parameters:</strong></p>
@@ -3346,7 +3346,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":"2018-12-21T12:22:08.495Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:36.262Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_event_.eventdata.md
+15 -15
View File
@@ -29,7 +29,7 @@
*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)*
*Defined in [Event.ts:27](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Event.ts#L27)*
*Defined in [Event.ts:27](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L27)*
**Parameters:**
@@ -72,7 +72,7 @@ getTypes(): `Array`<`string`>
*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)*
*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L65)*
*Defined in [codec/Tuple.ts:65](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L65)*
*__description__*: The types definition of the tuple
@@ -87,7 +87,7 @@ getencodedLength(): `number`
*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)*
*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L56)*
*Defined in [codec/Tuple.ts:56](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L56)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -100,7 +100,7 @@ ___
getmeta(): [EventMetadata](_metadata_events_.eventmetadata.md)
*Defined in [Event.ts:41](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Event.ts#L41)*
*Defined in [Event.ts:41](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L41)*
*__description__*: The wrapped [EventMetadata](_metadata_events_.eventmetadata.md)
@@ -113,7 +113,7 @@ ___
getmethod(): `string`
*Defined in [Event.ts:48](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Event.ts#L48)*
*Defined in [Event.ts:48](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L48)*
*__description__*: The method as a string
@@ -126,7 +126,7 @@ ___
getsection(): `string`
*Defined in [Event.ts:55](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Event.ts#L55)*
*Defined in [Event.ts:55](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L55)*
*__description__*: The section as a string
@@ -139,7 +139,7 @@ ___
gettypeDef(): `Array`<[TypeDef](../modules/_types_.md#typedef)>
*Defined in [Event.ts:62](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Event.ts#L62)*
*Defined in [Event.ts:62](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L62)*
*__description__*: The [TypeDef](../modules/_types_.md#typedef) for this event
@@ -309,7 +309,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L121)*
*Defined in [codec/Tuple.ts:121](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L121)*
*__description__*: Filters the array with the callback
@@ -729,7 +729,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L130)*
*Defined in [codec/Tuple.ts:130](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L130)*
*__description__*: Maps the array with the callback
@@ -1037,7 +1037,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L72)*
*Defined in [codec/Tuple.ts:72](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L72)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -1054,7 +1054,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)*
*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L79)*
*Defined in [codec/Tuple.ts:79](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L79)*
*__description__*: Returns a hex string representation of the value
@@ -1071,7 +1071,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)*
*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L86)*
*Defined in [codec/Tuple.ts:86](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L86)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1105,7 +1105,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L95)*
*Defined in [codec/Tuple.ts:95](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L95)*
*__description__*: Returns the string representation of the value
@@ -1120,7 +1120,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)*
*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L104)*
*Defined in [codec/Tuple.ts:104](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L104)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1177,7 +1177,7 @@ ___
*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)*
*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Tuple.ts#L43)*
*Defined in [codec/Tuple.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Tuple.ts#L43)*
**Type parameters:**
docs/types/classes/_event_.eventindex.html
+10 -10
View File
@@ -1976,7 +1976,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/db95340/packages/types/src/Event.ts#L73" target="_blank">Event.ts:73</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L73" target="_blank">Event.ts:73</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2034,7 +2034,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/db95340/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/1e88075/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>
@@ -2043,7 +2043,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/db95340/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/1e88075/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2059,7 +2059,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/db95340/packages/types/src/codec/U8aFixed.ts#L39" target="_blank">codec/U8aFixed.ts:39</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8aFixed.ts#L39" target="_blank">codec/U8aFixed.ts:39</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>
@@ -2726,7 +2726,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/db95340/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</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>
@@ -2757,7 +2757,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/db95340/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</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>
@@ -2766,7 +2766,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/db95340/packages/types/src/codec/U8a.ts#L67" target="_blank">codec/U8a.ts:67</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L67" target="_blank">codec/U8a.ts:67</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>
@@ -2784,7 +2784,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/db95340/packages/types/src/codec/U8a.ts#L74" target="_blank">codec/U8a.ts:74</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L74" target="_blank">codec/U8a.ts:74</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>
@@ -2792,7 +2792,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>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/db95340/packages/types/src/codec/U8a.ts#L82" target="_blank">codec/U8a.ts:82</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L82" target="_blank">codec/U8a.ts:82</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>
@@ -2864,7 +2864,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":"2018-12-21T12:22:08.627Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:36.406Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_event_.eventindex.md
+9 -9
View File
@@ -27,7 +27,7 @@
*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)*
*Defined in [Event.ts:73](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Event.ts#L73)*
*Defined in [Event.ts:73](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Event.ts#L73)*
**Parameters:**
@@ -115,7 +115,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -132,7 +132,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L43)*
*__description__*: The length of the value
@@ -163,7 +163,7 @@ ___
*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8aFixed.ts#L39)*
*Defined in [codec/U8aFixed.ts:39](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8aFixed.ts#L39)*
*__description__*: Returns the number of bits in the value
@@ -689,7 +689,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -713,7 +713,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L60)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60)*
*__description__*: Returns a hex string representation of the value
@@ -730,7 +730,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L67)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L67)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -764,7 +764,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L74)*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L74)*
*__description__*: Returns the string representation of the value
@@ -779,7 +779,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L82)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L82)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_eventrecord_.applyextrinsic.html
+10 -10
View File
@@ -1975,7 +1975,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/db95340/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/1e88075/packages/types/src/U32.ts#L14" target="_blank">U32.ts:14</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -1998,7 +1998,7 @@
<h2 id="encodedlength">encodedLength</h2>
<p>getencodedLength(): <code>number</code></p>
<p><em>Inherited from AbstractInt.encodedLength</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L56" target="_blank">codec/AbstractInt.ts:56</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L56" target="_blank">codec/AbstractInt.ts:56</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>
@@ -2131,7 +2131,7 @@
<p>&#x25B8; <strong>bitLength</strong>(): <a href="../modules/_codec_abstractint_.md#uintbitlength">UIntBitLength</a></p>
<p><em>Inherited from AbstractInt.bitLength</em></p>
<p><em>Overrides BN.bitLength</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L63" target="_blank">codec/AbstractInt.ts:63</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L63" target="_blank">codec/AbstractInt.ts:63</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>
@@ -3509,7 +3509,7 @@
<h2 id="tobn">toBn</h2>
<p>&#x25B8; <strong>toBn</strong>(): <code>BN</code></p>
<p><em>Inherited from AbstractInt.toBn</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L70" target="_blank">codec/AbstractInt.ts:70</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L70" target="_blank">codec/AbstractInt.ts:70</a></em></p>
<p><em><strong>description</strong></em>: Returns the BN representation of the number. (Compatibility)</p>
<p><strong>Returns:</strong> <code>BN</code></p>
<hr>
@@ -3546,7 +3546,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/db95340/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/1e88075/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>
@@ -3556,7 +3556,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 AbstractInt.toJSON</em></p>
<p><em>Overrides BN.toJSON</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L82" target="_blank">codec/AbstractInt.ts:82</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L82" target="_blank">codec/AbstractInt.ts:82</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>
@@ -3596,7 +3596,7 @@
<p>&#x25B8; <strong>toString</strong>(base?: <em> <code>undefined</code> | <code>number</code></em>): <code>string</code></p>
<p><em>Inherited from AbstractInt.toString</em></p>
<p><em>Overrides BN.toString</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L92" target="_blank">codec/AbstractInt.ts:92</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L92" target="_blank">codec/AbstractInt.ts:92</a></em></p>
<p><em><strong>description</strong></em>: Returns the string representation of the value</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -3645,7 +3645,7 @@
<p>&#x25B8; <strong>toU8a</strong>(isBare?: <em> <code>undefined</code> | <code>false</code> | <code>true</code></em>): <code>Uint8Array</code></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/db95340/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/1e88075/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>
@@ -3862,7 +3862,7 @@
<h2 id="static-decodeabstracint"><code>&lt;Static&gt;</code> decodeAbstracInt</h2>
<p>&#x25B8; <strong>decodeAbstracInt</strong>(value: <em><a href="../modules/_types_.md#anynumber">AnyNumber</a></em>, bitLength: <em><a href="../modules/_codec_abstractint_.md#uintbitlength">UIntBitLength</a></em>, isNegative: <em><code>boolean</code></em>): <code>string</code></p>
<p><em>Inherited from AbstractInt.decodeAbstracInt</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L37" target="_blank">codec/AbstractInt.ts:37</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L37" target="_blank">codec/AbstractInt.ts:37</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -4054,7 +4054,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":"2018-12-21T12:22:08.783Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:36.574Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_eventrecord_.applyextrinsic.md
+9 -9
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/db95340/packages/types/src/U32.ts#L14)*
*Defined in [U32.ts:14](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/U32.ts#L14)*
**Parameters:**
@@ -48,7 +48,7 @@ getencodedLength(): `number`
*Inherited from AbstractInt.encodedLength*
*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L56)*
*Defined in [codec/AbstractInt.ts:56](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L56)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -188,7 +188,7 @@ ___
*Overrides BN.bitLength*
*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L63)*
*Defined in [codec/AbstractInt.ts:63](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L63)*
*__description__*: Returns the number of bits in the value
@@ -1523,7 +1523,7 @@ ___
*Inherited from AbstractInt.toBn*
*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L70)*
*Defined in [codec/AbstractInt.ts:70](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L70)*
*__description__*: Returns the BN representation of the number. (Compatibility)
@@ -1564,7 +1564,7 @@ ___
*Overrides AbstractInt.toHex*
*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/UInt.ts#L36)*
*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/UInt.ts#L36)*
*__description__*: Returns a hex string representation of the value
@@ -1583,7 +1583,7 @@ ___
*Overrides BN.toJSON*
*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L82)*
*Defined in [codec/AbstractInt.ts:82](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L82)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1636,7 +1636,7 @@ ___
*Overrides BN.toString*
*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L92)*
*Defined in [codec/AbstractInt.ts:92](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L92)*
*__description__*: Returns the string representation of the value
@@ -1680,7 +1680,7 @@ ___
*Overrides AbstractInt.toU8a*
*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/UInt.ts#L48)*
*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/UInt.ts#L48)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1884,7 +1884,7 @@ ___
*Inherited from AbstractInt.decodeAbstracInt*
*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/AbstractInt.ts#L37)*
*Defined in [codec/AbstractInt.ts:37](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/AbstractInt.ts#L37)*
**Parameters:**
docs/types/classes/_eventrecord_.eventrecord.html
+14 -14
View File
@@ -1979,7 +1979,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/db95340/packages/types/src/EventRecord.ts#L47" target="_blank">EventRecord.ts:47</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/EventRecord.ts#L47" target="_blank">EventRecord.ts:47</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2015,7 +2015,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/db95340/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/1e88075/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>
@@ -2023,21 +2023,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/db95340/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/1e88075/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/db95340/packages/types/src/EventRecord.ts#L58" target="_blank">EventRecord.ts:58</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/EventRecord.ts#L58" target="_blank">EventRecord.ts:58</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/db95340/packages/types/src/EventRecord.ts#L65" target="_blank">EventRecord.ts:65</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/EventRecord.ts#L65" target="_blank">EventRecord.ts:65</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>
@@ -2118,7 +2118,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/db95340/packages/types/src/codec/Struct.ts#L159" target="_blank">codec/Struct.ts:159</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L159" target="_blank">codec/Struct.ts:159</a></em></p>
<p><em><strong>description</strong></em>: Returns a specific names entry in the structure</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2143,7 +2143,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L166" target="_blank">codec/Struct.ts:166</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>
@@ -2222,7 +2222,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L173" target="_blank">codec/Struct.ts:173</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>
@@ -2231,7 +2231,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L180" target="_blank">codec/Struct.ts:180</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>
@@ -2240,7 +2240,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L187" target="_blank">codec/Struct.ts:187</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>
@@ -2249,7 +2249,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/db95340/packages/types/src/codec/Struct.ts#L201" target="_blank">codec/Struct.ts:201</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L201" target="_blank">codec/Struct.ts:201</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>
@@ -2257,7 +2257,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>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/db95340/packages/types/src/codec/Struct.ts#L209" target="_blank">codec/Struct.ts:209</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L209" target="_blank">codec/Struct.ts:209</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>
@@ -2290,7 +2290,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/db95340/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/1e88075/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>
@@ -2353,7 +2353,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":"2018-12-21T12:22:08.823Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:36.618Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_eventrecord_.eventrecord.md
+13 -13
View File
@@ -29,7 +29,7 @@
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [EventRecord.ts:47](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/EventRecord.ts#L47)*
*Defined in [EventRecord.ts:47](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/EventRecord.ts#L47)*
**Parameters:**
@@ -76,7 +76,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L142)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L142)*
*__description__*: Returns the Type description to sthe structure
@@ -91,7 +91,7 @@ getencodedLength(): `number`
*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L149)*
*Defined in [codec/Struct.ts:149](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L149)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -104,7 +104,7 @@ ___
getevent(): [Event](_event_.event.md)
*Defined in [EventRecord.ts:58](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/EventRecord.ts#L58)*
*Defined in [EventRecord.ts:58](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/EventRecord.ts#L58)*
*__description__*: The [Event](_event_.event.md) this record refers to
@@ -117,7 +117,7 @@ ___
getphase(): [Phase](_eventrecord_.phase.md)
*Defined in [EventRecord.ts:65](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/EventRecord.ts#L65)*
*Defined in [EventRecord.ts:65](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/EventRecord.ts#L65)*
*__description__*: The [Phase](_eventrecord_.phase.md) where the event was generated
@@ -219,7 +219,7 @@ ___
*Overrides Map.get*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L159)*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L159)*
*__description__*: Returns a specific names entry in the structure
@@ -240,7 +240,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L166)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -315,7 +315,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L173)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L173)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -332,7 +332,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L180)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Returns a hex string representation of the value
@@ -349,7 +349,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L187)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L187)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -366,7 +366,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L201)*
*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L201)*
*__description__*: Returns the string representation of the value
@@ -381,7 +381,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L209)*
*Defined in [codec/Struct.ts:209](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L209)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -417,7 +417,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L122)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L122)*
**Type parameters:**
docs/types/classes/_eventrecord_.finalization.html
+6 -6
View File
@@ -1974,7 +1974,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/db95340/packages/types/src/Null.ts#L16" target="_blank">Null.ts:16</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Null.ts#L16" target="_blank">Null.ts:16</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>
@@ -1984,7 +1984,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/db95340/packages/types/src/Null.ts#L23" target="_blank">Null.ts:23</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Null.ts#L23" target="_blank">Null.ts:23</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>
@@ -1993,7 +1993,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/db95340/packages/types/src/Null.ts#L30" target="_blank">Null.ts:30</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Null.ts#L30" target="_blank">Null.ts:30</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>
@@ -2002,7 +2002,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/db95340/packages/types/src/Null.ts#L37" target="_blank">Null.ts:37</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Null.ts#L37" target="_blank">Null.ts:37</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>
@@ -2010,7 +2010,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>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/db95340/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/1e88075/packages/types/src/Null.ts#L45" target="_blank">Null.ts:45</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>
@@ -2074,7 +2074,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":"2018-12-21T12:22:08.843Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:36.638Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_eventrecord_.finalization.md
+5 -5
View File
@@ -24,7 +24,7 @@ getencodedLength(): `number`
*Inherited from [Null](_null_.null.md).[encodedLength](_null_.null.md#encodedlength)*
*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Null.ts#L16)*
*Defined in [Null.ts:16](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Null.ts#L16)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -44,7 +44,7 @@ ___
*Inherited from [Null](_null_.null.md).[toHex](_null_.null.md#tohex)*
*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Null.ts#L23)*
*Defined in [Null.ts:23](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Null.ts#L23)*
*__description__*: Returns a hex string representation of the value
@@ -61,7 +61,7 @@ ___
*Inherited from [Null](_null_.null.md).[toJSON](_null_.null.md#tojson)*
*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Null.ts#L30)*
*Defined in [Null.ts:30](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Null.ts#L30)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -78,7 +78,7 @@ ___
*Inherited from [Null](_null_.null.md).[toString](_null_.null.md#tostring)*
*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Null.ts#L37)*
*Defined in [Null.ts:37](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Null.ts#L37)*
*__description__*: Returns the string representation of the value
@@ -93,7 +93,7 @@ ___
*Inherited from [Null](_null_.null.md).[toU8a](_null_.null.md#tou8a)*
*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Null.ts#L45)*
*Defined in [Null.ts:45](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Null.ts#L45)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_eventrecord_.phase.html
+12 -12
View File
@@ -1974,7 +1974,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/db95340/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/1e88075/packages/types/src/EventRecord.ts#L32" target="_blank">EventRecord.ts:32</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2001,7 +2001,7 @@
<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/db95340/packages/types/src/codec/EnumType.ts#L97" target="_blank">codec/EnumType.ts:97</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L97" target="_blank">codec/EnumType.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>
@@ -2009,7 +2009,7 @@
<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/db95340/packages/types/src/codec/EnumType.ts#L104" target="_blank">codec/EnumType.ts:104</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L104" target="_blank">codec/EnumType.ts:104</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>
@@ -2017,7 +2017,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/db95340/packages/types/src/codec/EnumType.ts#L111" target="_blank">codec/EnumType.ts:111</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L111" target="_blank">codec/EnumType.ts:111</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>
@@ -2025,7 +2025,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/db95340/packages/types/src/codec/EnumType.ts#L118" target="_blank">codec/EnumType.ts:118</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L118" target="_blank">codec/EnumType.ts:118</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>
@@ -2033,7 +2033,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/db95340/packages/types/src/codec/EnumType.ts#L125" target="_blank">codec/EnumType.ts:125</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L125" target="_blank">codec/EnumType.ts:125</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>
@@ -2043,7 +2043,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/db95340/packages/types/src/codec/EnumType.ts#L132" target="_blank">codec/EnumType.ts:132</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L132" target="_blank">codec/EnumType.ts:132</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>
@@ -2052,7 +2052,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/db95340/packages/types/src/codec/EnumType.ts#L139" target="_blank">codec/EnumType.ts:139</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L139" target="_blank">codec/EnumType.ts:139</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>
@@ -2060,7 +2060,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/db95340/packages/types/src/codec/EnumType.ts#L146" target="_blank">codec/EnumType.ts:146</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L146" target="_blank">codec/EnumType.ts:146</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>
@@ -2069,7 +2069,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/db95340/packages/types/src/codec/EnumType.ts#L153" target="_blank">codec/EnumType.ts:153</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L153" target="_blank">codec/EnumType.ts:153</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>
@@ -2077,7 +2077,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>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/db95340/packages/types/src/codec/EnumType.ts#L161" target="_blank">codec/EnumType.ts:161</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L161" target="_blank">codec/EnumType.ts:161</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>
@@ -2141,7 +2141,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":"2018-12-21T12:22:08.875Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:36.666Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_eventrecord_.phase.md
+11 -11
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/db95340/packages/types/src/EventRecord.ts#L32)*
*Defined in [EventRecord.ts:32](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/EventRecord.ts#L32)*
**Parameters:**
@@ -47,7 +47,7 @@ getencodedLength(): `number`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)*
*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L97)*
*Defined in [codec/EnumType.ts:97](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L97)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -62,7 +62,7 @@ getisNone(): `boolean`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)*
*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L104)*
*Defined in [codec/EnumType.ts:104](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L104)*
*__description__*: Checks if the Enum points to a [Null](_null_.null.md) type
@@ -77,7 +77,7 @@ getisNull(): `boolean`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)*
*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L111)*
*Defined in [codec/EnumType.ts:111](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L111)*
*__description__*: Checks if the Enum points to a [Null](_null_.null.md) type (deprecated, use isNone)
@@ -92,7 +92,7 @@ gettype(): `string`
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)*
*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L118)*
*Defined in [codec/EnumType.ts:118](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L118)*
*__description__*: The name of the type this enum value represents
@@ -107,7 +107,7 @@ getvalue(): [Codec](../interfaces/_types_.codec.md)
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)*
*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L125)*
*Defined in [codec/EnumType.ts:125](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L125)*
*__description__*: The value of the enum
@@ -127,7 +127,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)*
*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L132)*
*Defined in [codec/EnumType.ts:132](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L132)*
*__description__*: Returns a hex string representation of the value
@@ -144,7 +144,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)*
*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L139)*
*Defined in [codec/EnumType.ts:139](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L139)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -159,7 +159,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)*
*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L146)*
*Defined in [codec/EnumType.ts:146](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L146)*
*__description__*: Returns the number representation for the value
@@ -176,7 +176,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)*
*Defined in [codec/EnumType.ts:153](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L153)*
*Defined in [codec/EnumType.ts:153](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L153)*
*__description__*: Returns the string representation of the value
@@ -191,7 +191,7 @@ ___
*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)*
*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/EnumType.ts#L161)*
*Defined in [codec/EnumType.ts:161](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/EnumType.ts#L161)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
docs/types/classes/_extrinsic_.extrinsic.html
+24 -24
View File
@@ -1985,7 +1985,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/db95340/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/1e88075/packages/types/src/Extrinsic.ts#L36" target="_blank">Extrinsic.ts:36</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2021,28 +2021,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/db95340/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/1e88075/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/db95340/packages/types/src/Extrinsic.ts#L71" target="_blank">Extrinsic.ts:71</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L71" target="_blank">Extrinsic.ts:71</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/db95340/packages/types/src/Extrinsic.ts#L78" target="_blank">Extrinsic.ts:78</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L78" target="_blank">Extrinsic.ts:78</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/db95340/packages/types/src/Extrinsic.ts#L85" target="_blank">Extrinsic.ts:85</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L85" target="_blank">Extrinsic.ts:85</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>
@@ -2050,49 +2050,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/db95340/packages/types/src/Extrinsic.ts#L92" target="_blank">Extrinsic.ts:92</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L92" target="_blank">Extrinsic.ts:92</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/db95340/packages/types/src/Extrinsic.ts#L101" target="_blank">Extrinsic.ts:101</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L101" target="_blank">Extrinsic.ts:101</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/db95340/packages/types/src/Extrinsic.ts#L110" target="_blank">Extrinsic.ts:110</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L110" target="_blank">Extrinsic.ts:110</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/db95340/packages/types/src/Extrinsic.ts#L117" target="_blank">Extrinsic.ts:117</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L117" target="_blank">Extrinsic.ts:117</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/db95340/packages/types/src/Extrinsic.ts#L124" target="_blank">Extrinsic.ts:124</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L124" target="_blank">Extrinsic.ts:124</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>
<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/db95340/packages/types/src/Extrinsic.ts#L131" target="_blank">Extrinsic.ts:131</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L131" target="_blank">Extrinsic.ts:131</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/db95340/packages/types/src/Extrinsic.ts#L138" target="_blank">Extrinsic.ts:138</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L138" target="_blank">Extrinsic.ts:138</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>
@@ -2108,7 +2108,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/db95340/packages/types/src/Extrinsic.ts#L145" target="_blank">Extrinsic.ts:145</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L145" target="_blank">Extrinsic.ts:145</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>
@@ -2207,7 +2207,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/db95340/packages/types/src/codec/Struct.ts#L159" target="_blank">codec/Struct.ts:159</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L159" target="_blank">codec/Struct.ts:159</a></em></p>
<p><em><strong>description</strong></em>: Returns a specific names entry in the structure</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2232,7 +2232,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L166" target="_blank">codec/Struct.ts:166</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>
@@ -2310,7 +2310,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/db95340/packages/types/src/Extrinsic.ts#L154" target="_blank">Extrinsic.ts:154</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L154" target="_blank">Extrinsic.ts:154</a></em></p>
<p><em><strong>description</strong></em>: Sign the extrinsic with a specific keypair</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2345,7 +2345,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L173" target="_blank">codec/Struct.ts:173</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>
@@ -2354,7 +2354,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/db95340/packages/types/src/Extrinsic.ts#L163" target="_blank">Extrinsic.ts:163</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L163" target="_blank">Extrinsic.ts:163</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>
@@ -2363,7 +2363,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/db95340/packages/types/src/Extrinsic.ts#L170" target="_blank">Extrinsic.ts:170</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L170" target="_blank">Extrinsic.ts:170</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>
@@ -2372,7 +2372,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/db95340/packages/types/src/codec/Struct.ts#L201" target="_blank">codec/Struct.ts:201</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L201" target="_blank">codec/Struct.ts:201</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>
@@ -2380,7 +2380,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>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/db95340/packages/types/src/Extrinsic.ts#L178" target="_blank">Extrinsic.ts:178</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L178" target="_blank">Extrinsic.ts:178</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>
@@ -2412,7 +2412,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/db95340/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/1e88075/packages/types/src/Extrinsic.ts#L44" target="_blank">Extrinsic.ts:44</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2434,7 +2434,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/db95340/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/1e88075/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>
@@ -2497,7 +2497,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":"2018-12-21T12:22:08.947Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:36.738Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_extrinsic_.extrinsic.md
+23 -23
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/db95340/packages/types/src/Extrinsic.ts#L36)*
*Defined in [Extrinsic.ts:36](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L36)*
**Parameters:**
@@ -83,7 +83,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L142)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L142)*
*__description__*: Returns the Type description to sthe structure
@@ -96,7 +96,7 @@ ___
getargs(): `Array`<[Codec](../interfaces/_types_.codec.md)>
*Defined in [Extrinsic.ts:71](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Extrinsic.ts#L71)*
*Defined in [Extrinsic.ts:71](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L71)*
*__description__*: The arguments passed to for the call, exposes args so it is compatible with [Method](_method_.method.md)
@@ -109,7 +109,7 @@ ___
getcallIndex(): `Uint8Array`
*Defined in [Extrinsic.ts:78](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Extrinsic.ts#L78)*
*Defined in [Extrinsic.ts:78](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L78)*
*__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method
@@ -122,7 +122,7 @@ ___
getdata(): `Uint8Array`
*Defined in [Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Extrinsic.ts#L85)*
*Defined in [Extrinsic.ts:85](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L85)*
*__description__*: The actual data for the Method
@@ -137,7 +137,7 @@ getencodedLength(): `number`
*Overrides [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
*Defined in [Extrinsic.ts:92](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Extrinsic.ts#L92)*
*Defined in [Extrinsic.ts:92](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L92)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -150,7 +150,7 @@ ___
gethash(): [Hash](_hash_.hash.md)
*Defined in [Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Extrinsic.ts#L101)*
*Defined in [Extrinsic.ts:101](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L101)*
*__description__*: Convernience function, encodes the extrinsic and returns the actual hash
@@ -163,7 +163,7 @@ ___
getisSigned(): `boolean`
*Defined in [Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Extrinsic.ts#L110)*
*Defined in [Extrinsic.ts:110](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L110)*
*__description__*: `true` id the extrinsic is signed
@@ -176,7 +176,7 @@ ___
getlength(): `number`
*Defined in [Extrinsic.ts:117](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Extrinsic.ts#L117)*
*Defined in [Extrinsic.ts:117](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L117)*
*__description__*: The length of the encoded value
@@ -189,7 +189,7 @@ ___
getmeta(): [FunctionMetadata](_metadata_modules_.functionmetadata.md)
*Defined in [Extrinsic.ts:124](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Extrinsic.ts#L124)*
*Defined in [Extrinsic.ts:124](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L124)*
*__description__*: The [FunctionMetadata](_metadata_modules_.functionmetadata.md) that describes the extrinsic
@@ -202,7 +202,7 @@ ___
getmethod(): [Method](_method_.method.md)
*Defined in [Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Extrinsic.ts#L131)*
*Defined in [Extrinsic.ts:131](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L131)*
*__description__*: The [Method](_method_.method.md) this extrinsic wraps
@@ -215,7 +215,7 @@ ___
getsignature(): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md)
*Defined in [Extrinsic.ts:138](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Extrinsic.ts#L138)*
*Defined in [Extrinsic.ts:138](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L138)*
*__description__*: The [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md)
@@ -246,7 +246,7 @@ ___
▸ **addSignature**(signer: * [Address](_address_.address.md) &#124; `Uint8Array`*, signature: *`Uint8Array`*, nonce: *[AnyNumber](../modules/_types_.md#anynumber)*, era?: *[Uint8Array](_codec_u8a_.u8a.md#uint8array)*): [Extrinsic](_extrinsic_.extrinsic.md)
*Defined in [Extrinsic.ts:145](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Extrinsic.ts#L145)*
*Defined in [Extrinsic.ts:145](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L145)*
*__description__*: Add an [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) to the extrinsic (already generated)
@@ -339,7 +339,7 @@ ___
*Overrides Map.get*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L159)*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L159)*
*__description__*: Returns a specific names entry in the structure
@@ -360,7 +360,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L166)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -433,7 +433,7 @@ ___
▸ **sign**(signerPair: *`KeyringPair`*, nonce: *[AnyNumber](../modules/_types_.md#anynumber)*, blockHash: *[AnyU8a](../modules/_types_.md#anyu8a)*, era?: *[Uint8Array](_codec_u8a_.u8a.md#uint8array)*): [Extrinsic](_extrinsic_.extrinsic.md)
*Defined in [Extrinsic.ts:154](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Extrinsic.ts#L154)*
*Defined in [Extrinsic.ts:154](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L154)*
*__description__*: Sign the extrinsic with a specific keypair
@@ -457,7 +457,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L173)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L173)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -474,7 +474,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
*Defined in [Extrinsic.ts:163](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Extrinsic.ts#L163)*
*Defined in [Extrinsic.ts:163](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L163)*
*__description__*: Returns a hex string representation of the value
@@ -491,7 +491,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [Extrinsic.ts:170](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Extrinsic.ts#L170)*
*Defined in [Extrinsic.ts:170](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L170)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -508,7 +508,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L201)*
*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L201)*
*__description__*: Returns the string representation of the value
@@ -523,7 +523,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [Extrinsic.ts:178](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Extrinsic.ts#L178)*
*Defined in [Extrinsic.ts:178](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L178)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -557,7 +557,7 @@ ___
▸ **decodeExtrinsic**(value: * `ExtrinsicValue` &#124; [AnyU8a](../modules/_types_.md#anyu8a) &#124; [Method](_method_.method.md)*): `ExtrinsicValue` &#124; `Array`<`number`> &#124; `Uint8Array`
*Defined in [Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/Extrinsic.ts#L44)*
*Defined in [Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/Extrinsic.ts#L44)*
**Parameters:**
@@ -576,7 +576,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L122)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L122)*
**Type parameters:**
docs/types/classes/_extrinsicera_.extrinsicera.html
+10 -10
View File
@@ -1976,7 +1976,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/db95340/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/1e88075/packages/types/src/ExtrinsicEra.ts#L16" target="_blank">ExtrinsicEra.ts:16</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2034,7 +2034,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/db95340/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/1e88075/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>
@@ -2043,7 +2043,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/db95340/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/1e88075/packages/types/src/codec/U8a.ts#L43" target="_blank">codec/U8a.ts:43</a></em></p>
<p><em><strong>description</strong></em>: The length of the value</p>
<p><strong>Returns:</strong> <code>number</code></p>
<hr>
@@ -2718,7 +2718,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/db95340/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53" target="_blank">codec/U8a.ts:53</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>
@@ -2749,7 +2749,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/db95340/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60" target="_blank">codec/U8a.ts:60</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>
@@ -2758,7 +2758,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/db95340/packages/types/src/codec/U8a.ts#L67" target="_blank">codec/U8a.ts:67</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L67" target="_blank">codec/U8a.ts:67</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>
@@ -2776,7 +2776,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/db95340/packages/types/src/codec/U8a.ts#L74" target="_blank">codec/U8a.ts:74</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L74" target="_blank">codec/U8a.ts:74</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>
@@ -2784,7 +2784,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>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/db95340/packages/types/src/codec/U8a.ts#L82" target="_blank">codec/U8a.ts:82</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L82" target="_blank">codec/U8a.ts:82</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>
@@ -2816,7 +2816,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/db95340/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/1e88075/packages/types/src/ExtrinsicEra.ts#L23" target="_blank">ExtrinsicEra.ts:23</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2877,7 +2877,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":"2018-12-21T12:22:09.059Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:36.854Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_extrinsicera_.extrinsicera.md
+9 -9
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/db95340/packages/types/src/ExtrinsicEra.ts#L16)*
*Defined in [ExtrinsicEra.ts:16](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicEra.ts#L16)*
**Parameters:**
@@ -115,7 +115,7 @@ getencodedLength(): `number`
*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L36)*
*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L36)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -132,7 +132,7 @@ getlength(): `number`
*Overrides Uint8Array.length*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L43)*
*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L43)*
*__description__*: The length of the value
@@ -674,7 +674,7 @@ ___
*Overrides Uint8Array.subarray*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L53)*
*Defined in [codec/U8a.ts:53](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L53)*
*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here
@@ -698,7 +698,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L60)*
*Defined in [codec/U8a.ts:60](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L60)*
*__description__*: Returns a hex string representation of the value
@@ -715,7 +715,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L67)*
*Defined in [codec/U8a.ts:67](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L67)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -749,7 +749,7 @@ ___
*Overrides Uint8Array.toString*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L74)*
*Defined in [codec/U8a.ts:74](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L74)*
*__description__*: Returns the string representation of the value
@@ -764,7 +764,7 @@ ___
*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/U8a.ts#L82)*
*Defined in [codec/U8a.ts:82](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/U8a.ts#L82)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -798,7 +798,7 @@ ___
▸ **decodeExtrinsicEra**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): `Uint8Array`
*Defined in [ExtrinsicEra.ts:23](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/ExtrinsicEra.ts#L23)*
*Defined in [ExtrinsicEra.ts:23](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicEra.ts#L23)*
**Parameters:**
docs/types/classes/_extrinsics_.extrinsics.html
+14 -14
View File
@@ -1979,7 +1979,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/db95340/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/1e88075/packages/types/src/codec/Vector.ts#L22" target="_blank">codec/Vector.ts:22</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2009,14 +2009,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/db95340/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/1e88075/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/db95340/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/1e88075/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>
@@ -2025,7 +2025,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/db95340/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/1e88075/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>
@@ -2206,7 +2206,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/db95340/packages/types/src/codec/Vector.ts#L139" target="_blank">codec/Vector.ts:139</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L139" target="_blank">codec/Vector.ts:139</a></em></p>
<p><em><strong>description</strong></em>: Filters the array with the callback</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2759,7 +2759,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/db95340/packages/types/src/codec/Vector.ts#L148" target="_blank">codec/Vector.ts:148</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L148" target="_blank">codec/Vector.ts:148</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>
@@ -3141,7 +3141,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/db95340/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/1e88075/packages/types/src/codec/Vector.ts#L81" target="_blank">codec/Vector.ts:81</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>
@@ -3150,7 +3150,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/db95340/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/1e88075/packages/types/src/codec/Vector.ts#L88" target="_blank">codec/Vector.ts:88</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>
@@ -3159,7 +3159,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/db95340/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/1e88075/packages/types/src/codec/Vector.ts#L95" target="_blank">codec/Vector.ts:95</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>
@@ -3177,7 +3177,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/db95340/packages/types/src/codec/Vector.ts#L104" target="_blank">codec/Vector.ts:104</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L104" target="_blank">codec/Vector.ts:104</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>
@@ -3185,7 +3185,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>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/db95340/packages/types/src/codec/Vector.ts#L117" target="_blank">codec/Vector.ts:117</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L117" target="_blank">codec/Vector.ts:117</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>
@@ -3243,7 +3243,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/db95340/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/1e88075/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>
@@ -3271,7 +3271,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/db95340/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/1e88075/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>
@@ -3334,7 +3334,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":"2018-12-21T12:22:09.867Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:37.666Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_extrinsics_.extrinsics.md
+13 -13
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/db95340/packages/types/src/codec/Vector.ts#L22)*
*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/codec/Vector.ts#L57)*
*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/codec/Vector.ts#L64)*
*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/codec/Vector.ts#L73)*
*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L73)*
*__description__*: The length of the value
@@ -254,7 +254,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L139)*
*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L139)*
*__description__*: Filters the array with the callback
@@ -674,7 +674,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L148)*
*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L148)*
*__description__*: Maps the array with the callback
@@ -982,7 +982,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)*
*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L81)*
*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L81)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -999,7 +999,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)*
*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L88)*
*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L88)*
*__description__*: Returns a hex string representation of the value
@@ -1016,7 +1016,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)*
*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L95)*
*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L95)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1050,7 +1050,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L104)*
*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L104)*
*__description__*: Returns the string representation of the value
@@ -1065,7 +1065,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)*
*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L117)*
*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L117)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1122,7 +1122,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[decodeVector](_codec_vector_.vector.md#decodevector)*
*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L32)*
*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L32)*
**Type parameters:**
@@ -1145,7 +1145,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)*
*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L49)*
*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L49)*
**Type parameters:**
docs/types/classes/_extrinsicsignature_.extrinsicsignature.html
+21 -21
View File
@@ -1979,7 +1979,7 @@
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new ExtrinsicSignature</strong>(value?: <em> <code>ExtrinsicSignatureValue</code> | <code>Uint8Array</code></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/db95340/packages/types/src/ExtrinsicSignature.ts#L37" target="_blank">ExtrinsicSignature.ts:37</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicSignature.ts#L37" target="_blank">ExtrinsicSignature.ts:37</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2015,7 +2015,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/db95340/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/1e88075/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>
@@ -2023,49 +2023,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/db95340/packages/types/src/ExtrinsicSignature.ts#L71" target="_blank">ExtrinsicSignature.ts:71</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicSignature.ts#L71" target="_blank">ExtrinsicSignature.ts:71</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/db95340/packages/types/src/ExtrinsicSignature.ts#L90" target="_blank">ExtrinsicSignature.ts:90</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicSignature.ts#L90" target="_blank">ExtrinsicSignature.ts:90</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/db95340/packages/types/src/ExtrinsicSignature.ts#L83" target="_blank">ExtrinsicSignature.ts:83</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicSignature.ts#L83" target="_blank">ExtrinsicSignature.ts:83</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/db95340/packages/types/src/ExtrinsicSignature.ts#L97" target="_blank">ExtrinsicSignature.ts:97</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicSignature.ts#L97" target="_blank">ExtrinsicSignature.ts:97</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/db95340/packages/types/src/ExtrinsicSignature.ts#L104" target="_blank">ExtrinsicSignature.ts:104</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicSignature.ts#L104" target="_blank">ExtrinsicSignature.ts:104</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/db95340/packages/types/src/ExtrinsicSignature.ts#L111" target="_blank">ExtrinsicSignature.ts:111</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicSignature.ts#L111" target="_blank">ExtrinsicSignature.ts:111</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/db95340/packages/types/src/ExtrinsicSignature.ts#L118" target="_blank">ExtrinsicSignature.ts:118</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicSignature.ts#L118" target="_blank">ExtrinsicSignature.ts:118</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>
@@ -2081,7 +2081,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/db95340/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/1e88075/packages/types/src/ExtrinsicSignature.ts#L142" target="_blank">ExtrinsicSignature.ts:142</a></em></p>
<p><em><strong>description</strong></em>: Adds a raw signature</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2185,7 +2185,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/db95340/packages/types/src/codec/Struct.ts#L159" target="_blank">codec/Struct.ts:159</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L159" target="_blank">codec/Struct.ts:159</a></em></p>
<p><em><strong>description</strong></em>: Returns a specific names entry in the structure</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2210,7 +2210,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L166" target="_blank">codec/Struct.ts:166</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>
@@ -2288,7 +2288,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/db95340/packages/types/src/ExtrinsicSignature.ts#L154" target="_blank">ExtrinsicSignature.ts:154</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicSignature.ts#L154" target="_blank">ExtrinsicSignature.ts:154</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>
@@ -2333,7 +2333,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L173" target="_blank">codec/Struct.ts:173</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>
@@ -2342,7 +2342,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L180" target="_blank">codec/Struct.ts:180</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>
@@ -2351,7 +2351,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/db95340/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/1e88075/packages/types/src/codec/Struct.ts#L187" target="_blank">codec/Struct.ts:187</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>
@@ -2360,7 +2360,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/db95340/packages/types/src/codec/Struct.ts#L201" target="_blank">codec/Struct.ts:201</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L201" target="_blank">codec/Struct.ts:201</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>
@@ -2368,7 +2368,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>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/db95340/packages/types/src/ExtrinsicSignature.ts#L171" target="_blank">ExtrinsicSignature.ts:171</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicSignature.ts#L171" target="_blank">ExtrinsicSignature.ts:171</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>
@@ -2400,7 +2400,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="_extrinsicsignature_.extrinsicsignature.html">ExtrinsicSignature</a> | <code>ExtrinsicSignatureValue</code> | <a href="../modules/_types_.md#anyu8a">AnyU8a</a> | <code>undefined</code></em>): <code>object</code> | <code>Uint8Array</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/db95340/packages/types/src/ExtrinsicSignature.ts#L52" target="_blank">ExtrinsicSignature.ts:52</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicSignature.ts#L52" target="_blank">ExtrinsicSignature.ts:52</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2422,7 +2422,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/db95340/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/1e88075/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>
@@ -2485,7 +2485,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":"2018-12-21T12:22:09.127Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:36.926Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_extrinsicsignature_.extrinsicsignature.md
+20 -20
View File
@@ -29,7 +29,7 @@
*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)*
*Defined in [ExtrinsicSignature.ts:37](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/ExtrinsicSignature.ts#L37)*
*Defined in [ExtrinsicSignature.ts:37](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicSignature.ts#L37)*
**Parameters:**
@@ -76,7 +76,7 @@ getType(): `E`
*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L142)*
*Defined in [codec/Struct.ts:142](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L142)*
*__description__*: Returns the Type description to sthe structure
@@ -91,7 +91,7 @@ getencodedLength(): `number`
*Overrides [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)*
*Defined in [ExtrinsicSignature.ts:71](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/ExtrinsicSignature.ts#L71)*
*Defined in [ExtrinsicSignature.ts:71](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicSignature.ts#L71)*
*__description__*: The length of the value when encoded as a Uint8Array
@@ -104,7 +104,7 @@ ___
getera(): [ExtrinsicEra](_extrinsicera_.extrinsicera.md)
*Defined in [ExtrinsicSignature.ts:90](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/ExtrinsicSignature.ts#L90)*
*Defined in [ExtrinsicSignature.ts:90](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicSignature.ts#L90)*
*__description__*: The [ExtrinsicEra](_extrinsicera_.extrinsicera.md) (mortal or immortal) this signature applies to
@@ -117,7 +117,7 @@ ___
getisSigned(): `boolean`
*Defined in [ExtrinsicSignature.ts:83](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/ExtrinsicSignature.ts#L83)*
*Defined in [ExtrinsicSignature.ts:83](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicSignature.ts#L83)*
*__description__*: `true` if the signature is valid
@@ -130,7 +130,7 @@ ___
getnonce(): [Nonce](_nonce_.nonce.md)
*Defined in [ExtrinsicSignature.ts:97](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/ExtrinsicSignature.ts#L97)*
*Defined in [ExtrinsicSignature.ts:97](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicSignature.ts#L97)*
*__description__*: The [Nonce](_nonce_.nonce.md) for the signature
@@ -143,7 +143,7 @@ ___
getsignature(): [Signature](_signature_.signature.md)
*Defined in [ExtrinsicSignature.ts:104](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/ExtrinsicSignature.ts#L104)*
*Defined in [ExtrinsicSignature.ts:104](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicSignature.ts#L104)*
*__description__*: The actuall [Signature](_signature_.signature.md) hash
@@ -156,7 +156,7 @@ ___
getsigner(): [Address](_address_.address.md)
*Defined in [ExtrinsicSignature.ts:111](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/ExtrinsicSignature.ts#L111)*
*Defined in [ExtrinsicSignature.ts:111](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicSignature.ts#L111)*
*__description__*: The [Address](_address_.address.md) that signed
@@ -169,7 +169,7 @@ ___
getversion(): `number`
*Defined in [ExtrinsicSignature.ts:118](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/ExtrinsicSignature.ts#L118)*
*Defined in [ExtrinsicSignature.ts:118](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicSignature.ts#L118)*
*__description__*: The encoded version for the signature
@@ -200,7 +200,7 @@ ___
▸ **addSignature**(_signer: * [Address](_address_.address.md) &#124; `Uint8Array`*, _signature: *`Uint8Array`*, _nonce: *[AnyNumber](../modules/_types_.md#anynumber)*, _era?: *`Uint8Array`*): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md)
*Defined in [ExtrinsicSignature.ts:142](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/ExtrinsicSignature.ts#L142)*
*Defined in [ExtrinsicSignature.ts:142](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicSignature.ts#L142)*
*__description__*: Adds a raw signature
@@ -293,7 +293,7 @@ ___
*Overrides Map.get*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L159)*
*Defined in [codec/Struct.ts:159](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L159)*
*__description__*: Returns a specific names entry in the structure
@@ -314,7 +314,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L166)*
*Defined in [codec/Struct.ts:166](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L166)*
*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -387,7 +387,7 @@ ___
▸ **sign**(method: *[Method](_method_.method.md)*, signerPair: *`KeyringPair`*, nonce: *[AnyNumber](../modules/_types_.md#anynumber)*, blockHash: *[AnyU8a](../modules/_types_.md#anyu8a)*, era?: *`Uint8Array`*): [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md)
*Defined in [ExtrinsicSignature.ts:154](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/ExtrinsicSignature.ts#L154)*
*Defined in [ExtrinsicSignature.ts:154](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicSignature.ts#L154)*
*__description__*: Generate a payload and pplies the signature from a keypair
@@ -412,7 +412,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L173)*
*Defined in [codec/Struct.ts:173](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L173)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -429,7 +429,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L180)*
*Defined in [codec/Struct.ts:180](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L180)*
*__description__*: Returns a hex string representation of the value
@@ -446,7 +446,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L187)*
*Defined in [codec/Struct.ts:187](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L187)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -463,7 +463,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)*
*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L201)*
*Defined in [codec/Struct.ts:201](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L201)*
*__description__*: Returns the string representation of the value
@@ -478,7 +478,7 @@ ___
*Overrides [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)*
*Defined in [ExtrinsicSignature.ts:171](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/ExtrinsicSignature.ts#L171)*
*Defined in [ExtrinsicSignature.ts:171](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicSignature.ts#L171)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -512,7 +512,7 @@ ___
▸ **decodeExtrinsicSignature**(value: * [ExtrinsicSignature](_extrinsicsignature_.extrinsicsignature.md) &#124; `ExtrinsicSignatureValue` &#124; [AnyU8a](../modules/_types_.md#anyu8a) &#124; `undefined`*): `object` &#124; `Uint8Array`
*Defined in [ExtrinsicSignature.ts:52](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/ExtrinsicSignature.ts#L52)*
*Defined in [ExtrinsicSignature.ts:52](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/ExtrinsicSignature.ts#L52)*
**Parameters:**
@@ -531,7 +531,7 @@ ___
*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Struct.ts#L122)*
*Defined in [codec/Struct.ts:122](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Struct.ts#L122)*
**Type parameters:**
docs/types/classes/_extrinsicstatus_.broadcast.html
+14 -14
View File
@@ -1978,7 +1978,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/db95340/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/1e88075/packages/types/src/codec/Vector.ts#L22" target="_blank">codec/Vector.ts:22</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2008,14 +2008,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/db95340/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/1e88075/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/db95340/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/1e88075/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>
@@ -2024,7 +2024,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/db95340/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/1e88075/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>
@@ -2205,7 +2205,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/db95340/packages/types/src/codec/Vector.ts#L139" target="_blank">codec/Vector.ts:139</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L139" target="_blank">codec/Vector.ts:139</a></em></p>
<p><em><strong>description</strong></em>: Filters the array with the callback</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2758,7 +2758,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/db95340/packages/types/src/codec/Vector.ts#L148" target="_blank">codec/Vector.ts:148</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L148" target="_blank">codec/Vector.ts:148</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>
@@ -3140,7 +3140,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/db95340/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/1e88075/packages/types/src/codec/Vector.ts#L81" target="_blank">codec/Vector.ts:81</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>
@@ -3149,7 +3149,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/db95340/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/1e88075/packages/types/src/codec/Vector.ts#L88" target="_blank">codec/Vector.ts:88</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>
@@ -3158,7 +3158,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/db95340/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/1e88075/packages/types/src/codec/Vector.ts#L95" target="_blank">codec/Vector.ts:95</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>
@@ -3176,7 +3176,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/db95340/packages/types/src/codec/Vector.ts#L104" target="_blank">codec/Vector.ts:104</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L104" target="_blank">codec/Vector.ts:104</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>
@@ -3184,7 +3184,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>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/db95340/packages/types/src/codec/Vector.ts#L117" target="_blank">codec/Vector.ts:117</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L117" target="_blank">codec/Vector.ts:117</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>
@@ -3242,7 +3242,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/db95340/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/1e88075/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>
@@ -3270,7 +3270,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/db95340/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/1e88075/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>
@@ -3333,7 +3333,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":"2018-12-21T12:22:09.311Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:22:51.633Z"},"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":"2018-12-21T12:42:37.110Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-21T12:43:18.642Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/types/classes/_extrinsicstatus_.broadcast.md
+13 -13
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/db95340/packages/types/src/codec/Vector.ts#L22)*
*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/codec/Vector.ts#L57)*
*Defined in [codec/Vector.ts:57](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/codec/Vector.ts#L64)*
*Defined in [codec/Vector.ts:64](https://github.com/polkadot-js/api/blob/1e88075/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/db95340/packages/types/src/codec/Vector.ts#L73)*
*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L73)*
*__description__*: The length of the value
@@ -252,7 +252,7 @@ ___
*Overrides Array.filter*
*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L139)*
*Defined in [codec/Vector.ts:139](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L139)*
*__description__*: Filters the array with the callback
@@ -672,7 +672,7 @@ ___
*Overrides Array.map*
*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L148)*
*Defined in [codec/Vector.ts:148](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L148)*
*__description__*: Maps the array with the callback
@@ -980,7 +980,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)*
*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L81)*
*Defined in [codec/Vector.ts:81](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L81)*
*__description__*: Converts the Object to an standard JavaScript Array
@@ -997,7 +997,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)*
*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L88)*
*Defined in [codec/Vector.ts:88](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L88)*
*__description__*: Returns a hex string representation of the value
@@ -1014,7 +1014,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)*
*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L95)*
*Defined in [codec/Vector.ts:95](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L95)*
*__description__*: Converts the Object to JSON, typically used for RPC transfers
@@ -1048,7 +1048,7 @@ ___
*Overrides Array.toString*
*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L104)*
*Defined in [codec/Vector.ts:104](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L104)*
*__description__*: Returns the string representation of the value
@@ -1063,7 +1063,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)*
*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L117)*
*Defined in [codec/Vector.ts:117](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L117)*
*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications
@@ -1120,7 +1120,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[decodeVector](_codec_vector_.vector.md#decodevector)*
*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L32)*
*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L32)*
**Type parameters:**
@@ -1143,7 +1143,7 @@ ___
*Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)*
*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/db95340/packages/types/src/codec/Vector.ts#L49)*
*Defined in [codec/Vector.ts:49](https://github.com/polkadot-js/api/blob/1e88075/packages/types/src/codec/Vector.ts#L49)*
**Type parameters:**

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