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

[CI Skip] 0.33.6

Browse Source
This commit is contained in:
Travis CI
2018-12-08 14:37:17 +00:00
parent 448a729d70
commit c30cecf0c1
350 changed files with 7154 additions and 43761 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/rpc-provider/classes/_coder_index_.rpccoder.md
+4 -4
View File
@@ -12,7 +12,7 @@
▸ **decodeResponse**(response: *[JsonRpcResponse](../modules/_types_.md#jsonrpcresponse)*): `any`
*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/coder/index.ts#L12)*
*Defined in [coder/index.ts:12](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/coder/index.ts#L12)*
**Parameters:**
@@ -29,7 +29,7 @@ ___
▸ **encodeJson**(method: *`string`*, params: * `any` &#124; `Array`<`any`>*): `string`
*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/coder/index.ts#L33)*
*Defined in [coder/index.ts:33](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/coder/index.ts#L33)*
**Parameters:**
@@ -47,7 +47,7 @@ ___
▸ **encodeObject**(method: *`string`*, params: * `any` &#124; `Array`<`any`>*): [JsonRpcRequest](../modules/_types_.md#jsonrpcrequest)
*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/coder/index.ts#L39)*
*Defined in [coder/index.ts:39](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/coder/index.ts#L39)*
**Parameters:**
@@ -65,7 +65,7 @@ ___
▸ **getId**(): `number`
*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/coder/index.ts#L48)*
*Defined in [coder/index.ts:48](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/coder/index.ts#L48)*
**Returns:** `number`
docs/rpc-provider/classes/_http_index_.httpprovider.html
+38 -38
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="../../types/classes/_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="../../types/classes/_metadata_.callmetadata.md">
<a href="../../types/classes/_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="../../types/classes/_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="../../types/classes/_metadata_.eventmetadata.md">
<a href="../../types/classes/_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="../../types/classes/_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="../../types/classes/_metadata_.functionargumentmetadata.md">
<a href="../../types/classes/_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="../../types/classes/_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="../../types/classes/_metadata_.functionmetadata.md">
<a href="../../types/classes/_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="../../types/classes/_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="../../types/classes/_metadata_.modulemetadata.md">
<a href="../../types/classes/_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="../../types/classes/_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="../../types/classes/_metadata_.outerdispatchcall.md">
<a href="../../types/classes/_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="../../types/classes/_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="../../types/classes/_metadata_.outerdispatchmetadata.md">
<a href="../../types/classes/_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="../../types/classes/_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="../../types/classes/_metadata_.outereventmetadata.md">
<a href="../../types/classes/_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="../../types/classes/_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="../../types/classes/_metadata_.outereventmetadataevent.md">
<a href="../../types/classes/_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="../../types/classes/_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="../../types/classes/_metadata_.runtimemodulemetadata.md">
<a href="../../types/classes/_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="../../types/classes/_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="../../types/classes/_metadata_.storagefunctionmetadata.md">
<a href="../../types/classes/_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="../../types/classes/_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="../../types/classes/_metadata_.storagefunctionmodifier.md">
<a href="../../types/classes/_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="../../types/classes/_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="../../types/classes/_metadata_.storagefunctiontype.md">
<a href="../../types/classes/_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="../../types/classes/_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="../../types/classes/_metadata_.storagefunctiontype_map.md">
<a href="../../types/classes/_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="../../types/classes/_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="../../types/classes/_metadata_.storagemetadata.md">
<a href="../../types/classes/_metadata_.storagemetadata.html">
<span>
hidden
@@ -1981,7 +1981,7 @@
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new HttpProvider</strong>(endpoint?: <em><code>string</code></em>): <a href="_http_index_.httpprovider.html">HttpProvider</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L40" target="_blank">http/index.ts:40</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L40" target="_blank">http/index.ts:40</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2007,7 +2007,7 @@
<p><a id="hassubscriptions"></a></p>
<h2 id="hassubscriptions">hasSubscriptions</h2>
<p>gethasSubscriptions(): <code>boolean</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L55" target="_blank">http/index.ts:55</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L55" target="_blank">http/index.ts:55</a></em></p>
<p><em><strong>summary</strong></em>: <code>true</code> when this provider supports subscriptions</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
@@ -2016,7 +2016,7 @@
<h2 id="isconnected">isConnected</h2>
<p>&#x25B8; <strong>isConnected</strong>(): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_.providerinterface.md#isconnected">isConnected</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L63" target="_blank">http/index.ts:63</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L63" target="_blank">http/index.ts:63</a></em></p>
<p><em><strong>summary</strong></em>: Whether the node is connected or not.</p>
<p><strong>Returns:</strong> <code>boolean</code>
true if connected</p>
@@ -2025,7 +2025,7 @@ true if connected</p>
<h2 id="on">on</h2>
<p>&#x25B8; <strong>on</strong>(type: <em><a href="../modules/_types_.md#providerinterface_emitted">ProviderInterface$Emitted</a></em>, sub: <em><a href="../modules/_types_.md#providerinterface_emitcb">ProviderInterface$EmitCb</a></em>): <code>void</code></p>
<p><em>Implementation of <a href="../interfaces/_types_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_.providerinterface.md#on">on</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L71" target="_blank">http/index.ts:71</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L71" target="_blank">http/index.ts:71</a></em></p>
<p><em><strong>summary</strong></em>: Events are not supported with the HttpProvider, see <a href="_ws_index_.wsprovider.html">WsProvider</a>.</p>
<p><em><strong>description</strong></em>: HTTP Provider does not have &apos;on&apos; emitters. WebSockets should be used instead.</p>
<p><strong>Parameters:</strong></p>
@@ -2053,7 +2053,7 @@ true if connected</p>
<h2 id="send">send</h2>
<p>&#x25B8; <strong>send</strong>(method: <em><code>string</code></em>, params: <em><code>Array</code>&lt;<code>any</code>&gt;</em>): <code>Promise</code>&lt;<code>any</code>&gt;</p>
<p><em>Implementation of <a href="../interfaces/_types_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_.providerinterface.md#send">send</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L78" target="_blank">http/index.ts:78</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L78" target="_blank">http/index.ts:78</a></em></p>
<p><em><strong>summary</strong></em>: Send HTTP POST Request with Body to configured HTTP Endpoint.</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2080,7 +2080,7 @@ true if connected</p>
<h2 id="subscribe">subscribe</h2>
<p>&#x25B8; <strong>subscribe</strong>(types: <em><code>string</code></em>, method: <em><code>string</code></em>, params: <em><code>Array</code>&lt;<code>any</code>&gt;</em>, cb: <em><a href="../modules/_types_.md#providerinterface_callback">ProviderInterface$Callback</a></em>): <code>Promise</code>&lt;<code>number</code>&gt;</p>
<p><em>Implementation of <a href="../interfaces/_types_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_.providerinterface.md#subscribe">subscribe</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L100" target="_blank">http/index.ts:100</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L100" target="_blank">http/index.ts:100</a></em></p>
<p><em><strong>summary</strong></em>: Subscriptions are not supported with the HttpProvider, see <a href="_ws_index_.wsprovider.html">WsProvider</a>.</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2115,7 +2115,7 @@ true if connected</p>
<h2 id="unsubscribe">unsubscribe</h2>
<p>&#x25B8; <strong>unsubscribe</strong>(type: <em><code>string</code></em>, method: <em><code>string</code></em>, id: <em><code>number</code></em>): <code>Promise</code>&lt;<code>boolean</code>&gt;</p>
<p><em>Implementation of <a href="../interfaces/_types_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_.providerinterface.md#unsubscribe">unsubscribe</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L109" target="_blank">http/index.ts:109</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L109" target="_blank">http/index.ts:109</a></em></p>
<p><em><strong>summary</strong></em>: Subscriptions are not supported with the HttpProvider, see <a href="_ws_index_.wsprovider.html">WsProvider</a>.</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2185,7 +2185,7 @@ true if connected</p>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"HttpProvider","level":"1.3.1","depth":2,"next":{"title":"WsProvider","level":"1.3.2","depth":2,"path":"rpc-provider/classes/_ws_index_.wsprovider.md","ref":"rpc-provider/classes/_ws_index_.wsprovider.md","articles":[]},"previous":{"title":"rpc-provider","level":"1.3","depth":1,"path":"rpc-provider/README.md","ref":"rpc-provider/README.md","articles":[{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},{"title":"WsProvider","level":"1.3.2","depth":2,"path":"rpc-provider/classes/_ws_index_.wsprovider.md","ref":"rpc-provider/classes/_ws_index_.wsprovider.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":"rpc-provider/classes/_http_index_.httpprovider.md","mtime":"2018-12-07T11:33:33.559Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"HttpProvider","level":"1.3.1","depth":2,"next":{"title":"WsProvider","level":"1.3.2","depth":2,"path":"rpc-provider/classes/_ws_index_.wsprovider.md","ref":"rpc-provider/classes/_ws_index_.wsprovider.md","articles":[]},"previous":{"title":"rpc-provider","level":"1.3","depth":1,"path":"rpc-provider/README.md","ref":"rpc-provider/README.md","articles":[{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},{"title":"WsProvider","level":"1.3.2","depth":2,"path":"rpc-provider/classes/_ws_index_.wsprovider.md","ref":"rpc-provider/classes/_ws_index_.wsprovider.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":"rpc-provider/classes/_http_index_.httpprovider.md","mtime":"2018-12-08T14:35:11.227Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/rpc-provider/classes/_http_index_.httpprovider.md
+7 -7
View File
@@ -34,7 +34,7 @@ const api = new Api(provider);
⊕ **new HttpProvider**(endpoint?: *`string`*): [HttpProvider](_http_index_.httpprovider.md)
*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L40)*
*Defined in [http/index.ts:40](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L40)*
**Parameters:**
@@ -54,7 +54,7 @@ ___
gethasSubscriptions(): `boolean`
*Defined in [http/index.ts:55](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L55)*
*Defined in [http/index.ts:55](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L55)*
*__summary__*: `true` when this provider supports subscriptions
@@ -72,7 +72,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)*
*Defined in [http/index.ts:63](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L63)*
*Defined in [http/index.ts:63](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L63)*
*__summary__*: Whether the node is connected or not.
@@ -88,7 +88,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)*
*Defined in [http/index.ts:71](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L71)*
*Defined in [http/index.ts:71](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L71)*
*__summary__*: Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
@@ -112,7 +112,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)*
*Defined in [http/index.ts:78](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L78)*
*Defined in [http/index.ts:78](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L78)*
*__summary__*: Send HTTP POST Request with Body to configured HTTP Endpoint.
@@ -134,7 +134,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[subscribe](../interfaces/_types_.providerinterface.md#subscribe)*
*Defined in [http/index.ts:100](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L100)*
*Defined in [http/index.ts:100](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L100)*
*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
@@ -158,7 +158,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)*
*Defined in [http/index.ts:109](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/index.ts#L109)*
*Defined in [http/index.ts:109](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/index.ts#L109)*
*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
docs/rpc-provider/classes/_mock_index_.mock.md
+9 -9
View File
@@ -19,7 +19,7 @@ A mock provider mainly used for testing.
⊕ **new Mock**(): [Mock](_mock_index_.mock.md)
*Defined in [mock/index.ts:64](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/index.ts#L64)*
*Defined in [mock/index.ts:64](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/index.ts#L64)*
**Returns:** [Mock](_mock_index_.mock.md)
@@ -33,7 +33,7 @@ ___
**● isUpdating**: *`boolean`* = true
*Defined in [mock/index.ts:42](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/index.ts#L42)*
*Defined in [mock/index.ts:42](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/index.ts#L42)*
___
<a id="subscriptions"></a>
@@ -49,7 +49,7 @@ ___
return subs;
}, ({} as MockState$Subscriptions))
*Defined in [mock/index.ts:53](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/index.ts#L53)*
*Defined in [mock/index.ts:53](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/index.ts#L53)*
___
@@ -61,7 +61,7 @@ ___
gethasSubscriptions(): `boolean`
*Defined in [mock/index.ts:70](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/index.ts#L70)*
*Defined in [mock/index.ts:70](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/index.ts#L70)*
**Returns:** `boolean`
@@ -77,7 +77,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[isConnected](../interfaces/_types_.providerinterface.md#isconnected)*
*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/index.ts#L74)*
*Defined in [mock/index.ts:74](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/index.ts#L74)*
**Returns:** `boolean`
@@ -90,7 +90,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[on](../interfaces/_types_.providerinterface.md#on)*
*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/index.ts#L78)*
*Defined in [mock/index.ts:78](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/index.ts#L78)*
**Parameters:**
@@ -110,7 +110,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[send](../interfaces/_types_.providerinterface.md#send)*
*Defined in [mock/index.ts:82](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/index.ts#L82)*
*Defined in [mock/index.ts:82](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/index.ts#L82)*
**Parameters:**
@@ -128,7 +128,7 @@ ___
▸ **subscribe**(type: *`string`*, method: *`string`*, ...params: *`Array`<`any`>*): `Promise`<`number`>
*Defined in [mock/index.ts:90](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/index.ts#L90)*
*Defined in [mock/index.ts:90](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/index.ts#L90)*
**Parameters:**
@@ -149,7 +149,7 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_.providerinterface.md).[unsubscribe](../interfaces/_types_.providerinterface.md#unsubscribe)*
*Defined in [mock/index.ts:110](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/index.ts#L110)*
*Defined in [mock/index.ts:110](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/index.ts#L110)*
**Parameters:**
docs/rpc-provider/classes/_ws_index_.wsprovider.html
+39 -39
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="../../types/classes/_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="../../types/classes/_metadata_.callmetadata.md">
<a href="../../types/classes/_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="../../types/classes/_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="../../types/classes/_metadata_.eventmetadata.md">
<a href="../../types/classes/_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="../../types/classes/_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="../../types/classes/_metadata_.functionargumentmetadata.md">
<a href="../../types/classes/_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="../../types/classes/_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="../../types/classes/_metadata_.functionmetadata.md">
<a href="../../types/classes/_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="../../types/classes/_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="../../types/classes/_metadata_.modulemetadata.md">
<a href="../../types/classes/_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="../../types/classes/_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="../../types/classes/_metadata_.outerdispatchcall.md">
<a href="../../types/classes/_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="../../types/classes/_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="../../types/classes/_metadata_.outerdispatchmetadata.md">
<a href="../../types/classes/_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="../../types/classes/_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="../../types/classes/_metadata_.outereventmetadata.md">
<a href="../../types/classes/_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="../../types/classes/_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="../../types/classes/_metadata_.outereventmetadataevent.md">
<a href="../../types/classes/_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="../../types/classes/_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="../../types/classes/_metadata_.runtimemodulemetadata.md">
<a href="../../types/classes/_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="../../types/classes/_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="../../types/classes/_metadata_.storagefunctionmetadata.md">
<a href="../../types/classes/_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="../../types/classes/_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="../../types/classes/_metadata_.storagefunctionmodifier.md">
<a href="../../types/classes/_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="../../types/classes/_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="../../types/classes/_metadata_.storagefunctiontype.md">
<a href="../../types/classes/_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="../../types/classes/_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="../../types/classes/_metadata_.storagefunctiontype_map.md">
<a href="../../types/classes/_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="../../types/classes/_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="../../types/classes/_metadata_.storagemetadata.md">
<a href="../../types/classes/_metadata_.storagemetadata.html">
<span>
hidden
@@ -1981,7 +1981,7 @@
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new WsProvider</strong>(endpoint?: <em><code>string</code></em>, autoConnect?: <em><code>boolean</code></em>): <a href="_ws_index_.wsprovider.html">WsProvider</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L75" target="_blank">ws/index.ts:75</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L75" target="_blank">ws/index.ts:75</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -2013,7 +2013,7 @@
<p><a id="hassubscriptions"></a></p>
<h2 id="hassubscriptions">hasSubscriptions</h2>
<p>gethasSubscriptions(): <code>boolean</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L101" target="_blank">ws/index.ts:101</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L101" target="_blank">ws/index.ts:101</a></em></p>
<p><em><strong>summary</strong></em>: <code>true</code> when this provider supports subscriptions</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
@@ -2021,7 +2021,7 @@
<p><a id="connect"></a></p>
<h2 id="connect">connect</h2>
<p>&#x25B8; <strong>connect</strong>(): <code>void</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L110" target="_blank">ws/index.ts:110</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L110" target="_blank">ws/index.ts:110</a></em></p>
<p><em><strong>summary</strong></em>: Manually connect</p>
<p><em><strong>description</strong></em>: The <a href="_ws_index_.wsprovider.html">WsProvider</a> connects automatically by default, however if you decided otherwise, you may connect manually using this method.</p>
<p><strong>Returns:</strong> <code>void</code></p>
@@ -2029,7 +2029,7 @@
<p><a id="isconnected"></a></p>
<h2 id="isconnected">isConnected</h2>
<p>&#x25B8; <strong>isConnected</strong>(): <code>boolean</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L127" target="_blank">ws/index.ts:127</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L127" target="_blank">ws/index.ts:127</a></em></p>
<p><em><strong>summary</strong></em>: Whether the node is connected or not.</p>
<p><strong>Returns:</strong> <code>boolean</code>
true if connected</p>
@@ -2037,7 +2037,7 @@ true if connected</p>
<p><a id="on"></a></p>
<h2 id="on">on</h2>
<p>&#x25B8; <strong>on</strong>(type: <em><a href="../modules/_types_.md#providerinterface_emitted">ProviderInterface$Emitted</a></em>, sub: <em><a href="../modules/_types_.md#providerinterface_emitcb">ProviderInterface$EmitCb</a></em>): <code>void</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L136" target="_blank">ws/index.ts:136</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L136" target="_blank">ws/index.ts:136</a></em></p>
<p><em><strong>summary</strong></em>: Listens on events after having subscribed using the <a href="_ws_index_.wsprovider.html#subscribe">subscribe</a> function.</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2066,7 +2066,7 @@ true if connected</p>
<p><a id="send"></a></p>
<h2 id="send">send</h2>
<p>&#x25B8; <strong>send</strong>(method: <em><code>string</code></em>, params: <em><code>Array</code>&lt;<code>any</code>&gt;</em>, subscription?: <em><code>SubscriptionHandler</code></em>): <code>Promise</code>&lt;<code>any</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L146" target="_blank">ws/index.ts:146</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L146" target="_blank">ws/index.ts:146</a></em></p>
<p><em><strong>summary</strong></em>: Send JSON data using WebSockets to configured HTTP Endpoint or queue.</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2100,7 +2100,7 @@ true if connected</p>
<p><a id="subscribe"></a></p>
<h2 id="subscribe">subscribe</h2>
<p>&#x25B8; <strong>subscribe</strong>(type: <em><code>string</code></em>, method: <em><code>string</code></em>, params: <em><code>Array</code>&lt;<code>any</code>&gt;</em>, callback: <em><a href="../modules/_types_.md#providerinterface_callback">ProviderInterface$Callback</a></em>): <code>Promise</code>&lt;<code>number</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L202" target="_blank">ws/index.ts:202</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L200" target="_blank">ws/index.ts:200</a></em></p>
<p><em><strong>name</strong></em>: subscribe</p>
<p><em><strong>summary</strong></em>: Allows subscribing to a specific event.</p>
<p><em><strong>example</strong></em>: </p>
@@ -2151,7 +2151,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
<p><a id="unsubscribe"></a></p>
<h2 id="unsubscribe">unsubscribe</h2>
<p>&#x25B8; <strong>unsubscribe</strong>(type: <em><code>string</code></em>, method: <em><code>string</code></em>, id: <em><code>number</code></em>): <code>Promise</code>&lt;<code>boolean</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L211" target="_blank">ws/index.ts:211</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L209" target="_blank">ws/index.ts:209</a></em></p>
<p><em><strong>summary</strong></em>: Allows unsubscribing to subscriptions made with <a href="_ws_index_.wsprovider.html#subscribe">subscribe</a>.</p>
<p><strong>Parameters:</strong></p>
<table>
@@ -2221,7 +2221,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"WsProvider","level":"1.3.2","depth":2,"next":{"title":"types (codec implementation)","level":"1.4","depth":1,"path":"types/README.md","ref":"types/README.md","articles":[]},"previous":{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.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":"rpc-provider/classes/_ws_index_.wsprovider.md","mtime":"2018-12-07T11:33:33.659Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"WsProvider","level":"1.3.2","depth":2,"next":{"title":"types (codec implementation)","level":"1.4","depth":1,"path":"types/README.md","ref":"types/README.md","articles":[]},"previous":{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.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":"rpc-provider/classes/_ws_index_.wsprovider.md","mtime":"2018-12-08T14:35:11.355Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/rpc-provider/classes/_ws_index_.wsprovider.md
+8 -8
View File
@@ -34,7 +34,7 @@ const api = new Api(provider);
⊕ **new WsProvider**(endpoint?: *`string`*, autoConnect?: *`boolean`*): [WsProvider](_ws_index_.wsprovider.md)
*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L75)*
*Defined in [ws/index.ts:75](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L75)*
**Parameters:**
@@ -55,7 +55,7 @@ ___
gethasSubscriptions(): `boolean`
*Defined in [ws/index.ts:101](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L101)*
*Defined in [ws/index.ts:101](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L101)*
*__summary__*: `true` when this provider supports subscriptions
@@ -71,7 +71,7 @@ ___
▸ **connect**(): `void`
*Defined in [ws/index.ts:110](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L110)*
*Defined in [ws/index.ts:110](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L110)*
*__summary__*: Manually connect
@@ -86,7 +86,7 @@ ___
▸ **isConnected**(): `boolean`
*Defined in [ws/index.ts:127](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L127)*
*Defined in [ws/index.ts:127](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L127)*
*__summary__*: Whether the node is connected or not.
@@ -100,7 +100,7 @@ ___
▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void`
*Defined in [ws/index.ts:136](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L136)*
*Defined in [ws/index.ts:136](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L136)*
*__summary__*: Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function.
@@ -120,7 +120,7 @@ ___
▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`>
*Defined in [ws/index.ts:146](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L146)*
*Defined in [ws/index.ts:146](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L146)*
*__summary__*: Send JSON data using WebSockets to configured HTTP Endpoint or queue.
@@ -141,7 +141,7 @@ ___
▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`>
*Defined in [ws/index.ts:202](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L202)*
*Defined in [ws/index.ts:200](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L200)*
*__name__*: subscribe
@@ -179,7 +179,7 @@ ___
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
*Defined in [ws/index.ts:211](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/ws/index.ts#L211)*
*Defined in [ws/index.ts:209](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/ws/index.ts#L209)*
*__summary__*: Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe).
docs/rpc-provider/index.html
+31 -31
View File
@@ -1122,9 +1122,9 @@
</li>
<li class="chapter " data-level="4.58" data-path="../types/classes/_metadata_.callmetadata.html">
<li class="chapter " data-level="4.58" data-path="../types/classes/_metadata_.callmetadata.md">
<a href="../types/classes/_metadata_.callmetadata.html">
<span>
hidden
@@ -1135,9 +1135,9 @@
</li>
<li class="chapter " data-level="4.59" data-path="../types/classes/_metadata_.eventmetadata.html">
<li class="chapter " data-level="4.59" data-path="../types/classes/_metadata_.eventmetadata.md">
<a href="../types/classes/_metadata_.eventmetadata.html">
<span>
hidden
@@ -1148,9 +1148,9 @@
</li>
<li class="chapter " data-level="4.60" data-path="../types/classes/_metadata_.functionargumentmetadata.html">
<li class="chapter " data-level="4.60" data-path="../types/classes/_metadata_.functionargumentmetadata.md">
<a href="../types/classes/_metadata_.functionargumentmetadata.html">
<span>
hidden
@@ -1161,9 +1161,9 @@
</li>
<li class="chapter " data-level="4.61" data-path="../types/classes/_metadata_.functionmetadata.html">
<li class="chapter " data-level="4.61" data-path="../types/classes/_metadata_.functionmetadata.md">
<a href="../types/classes/_metadata_.functionmetadata.html">
<span>
hidden
@@ -1174,9 +1174,9 @@
</li>
<li class="chapter " data-level="4.62" data-path="../types/classes/_metadata_.modulemetadata.html">
<li class="chapter " data-level="4.62" data-path="../types/classes/_metadata_.modulemetadata.md">
<a href="../types/classes/_metadata_.modulemetadata.html">
<span>
hidden
@@ -1187,9 +1187,9 @@
</li>
<li class="chapter " data-level="4.63" data-path="../types/classes/_metadata_.outerdispatchcall.html">
<li class="chapter " data-level="4.63" data-path="../types/classes/_metadata_.outerdispatchcall.md">
<a href="../types/classes/_metadata_.outerdispatchcall.html">
<span>
hidden
@@ -1200,9 +1200,9 @@
</li>
<li class="chapter " data-level="4.64" data-path="../types/classes/_metadata_.outerdispatchmetadata.html">
<li class="chapter " data-level="4.64" data-path="../types/classes/_metadata_.outerdispatchmetadata.md">
<a href="../types/classes/_metadata_.outerdispatchmetadata.html">
<span>
hidden
@@ -1213,9 +1213,9 @@
</li>
<li class="chapter " data-level="4.65" data-path="../types/classes/_metadata_.outereventmetadata.html">
<li class="chapter " data-level="4.65" data-path="../types/classes/_metadata_.outereventmetadata.md">
<a href="../types/classes/_metadata_.outereventmetadata.html">
<span>
hidden
@@ -1226,9 +1226,9 @@
</li>
<li class="chapter " data-level="4.66" data-path="../types/classes/_metadata_.outereventmetadataevent.html">
<li class="chapter " data-level="4.66" data-path="../types/classes/_metadata_.outereventmetadataevent.md">
<a href="../types/classes/_metadata_.outereventmetadataevent.html">
<span>
hidden
@@ -1252,9 +1252,9 @@
</li>
<li class="chapter " data-level="4.68" data-path="../types/classes/_metadata_.runtimemodulemetadata.html">
<li class="chapter " data-level="4.68" data-path="../types/classes/_metadata_.runtimemodulemetadata.md">
<a href="../types/classes/_metadata_.runtimemodulemetadata.html">
<span>
hidden
@@ -1265,9 +1265,9 @@
</li>
<li class="chapter " data-level="4.69" data-path="../types/classes/_metadata_.storagefunctionmetadata.html">
<li class="chapter " data-level="4.69" data-path="../types/classes/_metadata_.storagefunctionmetadata.md">
<a href="../types/classes/_metadata_.storagefunctionmetadata.html">
<span>
hidden
@@ -1278,9 +1278,9 @@
</li>
<li class="chapter " data-level="4.70" data-path="../types/classes/_metadata_.storagefunctionmodifier.html">
<li class="chapter " data-level="4.70" data-path="../types/classes/_metadata_.storagefunctionmodifier.md">
<a href="../types/classes/_metadata_.storagefunctionmodifier.html">
<span>
hidden
@@ -1291,9 +1291,9 @@
</li>
<li class="chapter " data-level="4.71" data-path="../types/classes/_metadata_.storagefunctiontype.html">
<li class="chapter " data-level="4.71" data-path="../types/classes/_metadata_.storagefunctiontype.md">
<a href="../types/classes/_metadata_.storagefunctiontype.html">
<span>
hidden
@@ -1304,9 +1304,9 @@
</li>
<li class="chapter " data-level="4.72" data-path="../types/classes/_metadata_.storagefunctiontype_map.html">
<li class="chapter " data-level="4.72" data-path="../types/classes/_metadata_.storagefunctiontype_map.md">
<a href="../types/classes/_metadata_.storagefunctiontype_map.html">
<span>
hidden
@@ -1317,9 +1317,9 @@
</li>
<li class="chapter " data-level="4.73" data-path="../types/classes/_metadata_.storagemetadata.html">
<li class="chapter " data-level="4.73" data-path="../types/classes/_metadata_.storagemetadata.md">
<a href="../types/classes/_metadata_.storagemetadata.html">
<span>
hidden
@@ -2029,7 +2029,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"rpc-provider","level":"1.3","depth":1,"next":{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},"previous":{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.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":"rpc-provider/README.md","mtime":"2018-12-07T11:33:33.375Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-07T11:34:45.610Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"rpc-provider","level":"1.3","depth":1,"next":{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},"previous":{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.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":"rpc-provider/README.md","mtime":"2018-12-08T14:35:11.051Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-12-08T14:36:23.372Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/rpc-provider/interfaces/_types_.providerinterface.md
+6 -6
View File
@@ -17,7 +17,7 @@
**● hasSubscriptions**: *`boolean`*
*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L45)*
*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L45)*
___
@@ -29,7 +29,7 @@ ___
▸ **isConnected**(): `boolean`
*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L46)*
*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L46)*
**Returns:** `boolean`
@@ -40,7 +40,7 @@ ___
▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void`
*Defined in [types.ts:47](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L47)*
*Defined in [types.ts:47](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L47)*
**Parameters:**
@@ -58,7 +58,7 @@ ___
▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`>
*Defined in [types.ts:48](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L48)*
*Defined in [types.ts:48](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L48)*
**Parameters:**
@@ -76,7 +76,7 @@ ___
▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`>
*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L49)*
*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L49)*
**Parameters:**
@@ -96,7 +96,7 @@ ___
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L50)*
*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L50)*
**Parameters:**
docs/rpc-provider/modules/_http_types_.md
+1 -1
View File
@@ -8,7 +8,7 @@
**Ƭ HttpState**: *`object`*
*Defined in [http/types.ts:9](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/http/types.ts#L9)*
*Defined in [http/types.ts:9](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/http/types.ts#L9)*
#### Type declaration
docs/rpc-provider/modules/_mock_types_.md
+4 -4
View File
@@ -8,7 +8,7 @@
**Ƭ MockState$Db**: *`object`*
*Defined in [mock/types.ts:16](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/types.ts#L16)*
*Defined in [mock/types.ts:16](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/types.ts#L16)*
#### Type declaration
@@ -21,7 +21,7 @@ ___
**Ƭ MockState$Requests**: *`object`*
*Defined in [mock/types.ts:20](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/types.ts#L20)*
*Defined in [mock/types.ts:20](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/types.ts#L20)*
#### Type declaration
@@ -45,7 +45,7 @@ ___
**Ƭ MockState$Subscription$Callback**: *`function`*
*Defined in [mock/types.ts:5](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/types.ts#L5)*
*Defined in [mock/types.ts:5](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/types.ts#L5)*
#### Type declaration
▸(error: * `Error` &#124; `null`*, value: *`any`*): `void`
@@ -66,7 +66,7 @@ ___
**Ƭ MockState$Subscriptions**: *`object`*
*Defined in [mock/types.ts:7](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/mock/types.ts#L7)*
*Defined in [mock/types.ts:7](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/mock/types.ts#L7)*
#### Type declaration
docs/rpc-provider/modules/_types_.md
+8 -8
View File
@@ -27,7 +27,7 @@
**Ƭ JsonRpcObject**: *`object`*
*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L5)*
*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L5)*
#### Type declaration
@@ -39,7 +39,7 @@ ___
**Ƭ JsonRpcRequest**: * [JsonRpcObject](_types_.md#jsonrpcobject) & `object`
*
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L10)*
*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L10)*
___
<a id="jsonrpcresponse"></a>
@@ -49,7 +49,7 @@ ___
**Ƭ JsonRpcResponse**: * [JsonRpcObject](_types_.md#jsonrpcobject) & [JsonRpcResponseBase](_types_.md#jsonrpcresponsebase)
*
*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L36)*
*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L36)*
___
<a id="jsonrpcresponsebase"></a>
@@ -59,7 +59,7 @@ ___
**Ƭ JsonRpcResponseBase**: * `JsonRpcResponse$Single` & `JsonRpcResponse$Subscription`
*
*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L34)*
*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L34)*
___
<a id="jsonrpcresponsebase_error"></a>
@@ -68,7 +68,7 @@ ___
**Ƭ JsonRpcResponseBase$Error**: *`object`*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L15)*
*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L15)*
#### Type declaration
@@ -79,7 +79,7 @@ ___
**Ƭ ProviderInterface$Callback**: *`function`*
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L38)*
*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L38)*
#### Type declaration
▸(result: *`any`*): `void`
@@ -99,7 +99,7 @@ ___
**Ƭ ProviderInterface$EmitCb**: *`function`*
*Defined in [types.ts:42](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L42)*
*Defined in [types.ts:42](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L42)*
#### Type declaration
▸(value?: *`any`*): `any`
@@ -120,7 +120,7 @@ ___
**Ƭ ProviderInterface$Emitted**: * "connected" &#124; "disconnected"
*
*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/69f6850/packages/rpc-provider/src/types.ts#L40)*
*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/448a729/packages/rpc-provider/src/types.ts#L40)*
___