Gitbook rendering updates (#159)
* Add .nodoc for in-flux packages * Start with clean-slate for re-generation * Update with working (although manual) config
This commit is contained in:
+65
-570
@@ -57,10 +57,10 @@
|
||||
<link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon">
|
||||
|
||||
|
||||
<link rel="next" href="../api-rx/" />
|
||||
<link rel="next" href="classes/_http_index_.httpprovider.html" />
|
||||
|
||||
|
||||
<link rel="prev" href="../api-format/" />
|
||||
<link rel="prev" href="../api/classes/_index_.api.html" />
|
||||
|
||||
|
||||
</head>
|
||||
@@ -87,7 +87,7 @@
|
||||
|
||||
|
||||
|
||||
<li class="header">Intro</li>
|
||||
<li class="header">Packages</li>
|
||||
|
||||
|
||||
|
||||
@@ -104,14 +104,7 @@
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="header">API</li>
|
||||
|
||||
|
||||
|
||||
<li class="chapter " data-level="2.1" data-path="../api/">
|
||||
<li class="chapter " data-level="1.2" data-path="../api/">
|
||||
|
||||
<a href="../api/">
|
||||
|
||||
@@ -122,14 +115,15 @@
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<ul class="articles">
|
||||
|
||||
|
||||
<li class="chapter " data-level="2.2" data-path="../api-format/">
|
||||
<li class="chapter " data-level="1.2.1" data-path="../api/classes/_index_.api.html">
|
||||
|
||||
<a href="../api-format/">
|
||||
<a href="../api/classes/_index_.api.html">
|
||||
|
||||
|
||||
api-format
|
||||
Api
|
||||
|
||||
</a>
|
||||
|
||||
@@ -137,7 +131,12 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="chapter active" data-level="2.3" data-path="./">
|
||||
|
||||
</ul>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="chapter active" data-level="1.3" data-path="./">
|
||||
|
||||
<a href="./">
|
||||
|
||||
@@ -148,9 +147,41 @@
|
||||
|
||||
|
||||
|
||||
<ul class="articles">
|
||||
|
||||
|
||||
<li class="chapter " data-level="1.3.1" data-path="classes/_http_index_.httpprovider.html">
|
||||
|
||||
<a href="classes/_http_index_.httpprovider.html">
|
||||
|
||||
|
||||
HttpProvider
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
<li class="chapter " data-level="2.4" data-path="../api-rx/">
|
||||
<li class="chapter " data-level="1.3.2" data-path="classes/_ws_index_.wsprovider.html">
|
||||
|
||||
<a href="classes/_ws_index_.wsprovider.html">
|
||||
|
||||
|
||||
WsProvider
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="chapter " data-level="1.4" data-path="../api-rx/">
|
||||
|
||||
<a href="../api-rx/">
|
||||
|
||||
@@ -161,14 +192,15 @@
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
<ul class="articles">
|
||||
|
||||
|
||||
<li class="chapter " data-level="2.5" data-path="../type-extrinsics/">
|
||||
<li class="chapter " data-level="1.4.1" data-path="../api-rx/classes/_index_.rxapi.html">
|
||||
|
||||
<a href="../type-extrinsics/">
|
||||
<a href="../api-rx/classes/_index_.rxapi.html">
|
||||
|
||||
|
||||
type-extrinsics
|
||||
ApiRx
|
||||
|
||||
</a>
|
||||
|
||||
@@ -176,55 +208,8 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="chapter " data-level="2.6" data-path="../type-jsonrpc/">
|
||||
|
||||
<a href="../type-jsonrpc/">
|
||||
|
||||
|
||||
type-jsonrpc
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
<li class="chapter " data-level="2.7" data-path="../type-params/">
|
||||
|
||||
<a href="../type-params/">
|
||||
|
||||
|
||||
type-params
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
<li class="chapter " data-level="2.8" data-path="../type-primitives/">
|
||||
|
||||
<a href="../type-primitives/">
|
||||
|
||||
|
||||
type-primitives
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
<li class="chapter " data-level="2.9" data-path="../type-storage/">
|
||||
|
||||
<a href="../type-storage/">
|
||||
|
||||
|
||||
type-storage
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
</li>
|
||||
|
||||
@@ -235,7 +220,7 @@
|
||||
|
||||
|
||||
|
||||
<li class="chapter " data-level="3.1" data-path="../examples/">
|
||||
<li class="chapter " data-level="2.1" data-path="../examples/">
|
||||
|
||||
<a href="../examples/">
|
||||
|
||||
@@ -248,7 +233,7 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="chapter " data-level="3.2" data-path="../examples/01_simple_connect/">
|
||||
<li class="chapter " data-level="2.2" data-path="../examples/01_simple_connect/">
|
||||
|
||||
<a href="../examples/01_simple_connect/">
|
||||
|
||||
@@ -261,7 +246,7 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="chapter " data-level="3.3" data-path="../examples/02_listen_to_blocks/">
|
||||
<li class="chapter " data-level="2.3" data-path="../examples/02_listen_to_blocks/">
|
||||
|
||||
<a href="../examples/02_listen_to_blocks/">
|
||||
|
||||
@@ -274,7 +259,7 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="chapter " data-level="3.4" data-path="../examples/03_listen_to_balance_change/">
|
||||
<li class="chapter " data-level="2.4" data-path="../examples/03_listen_to_balance_change/">
|
||||
|
||||
<a href="../examples/03_listen_to_balance_change/">
|
||||
|
||||
@@ -287,7 +272,7 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="chapter " data-level="3.5" data-path="../examples/04_generate_account/">
|
||||
<li class="chapter " data-level="2.5" data-path="../examples/04_generate_account/">
|
||||
|
||||
<a href="../examples/04_generate_account/">
|
||||
|
||||
@@ -300,7 +285,7 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="chapter " data-level="3.6" data-path="../examples/05_read_storage/">
|
||||
<li class="chapter " data-level="2.6" data-path="../examples/05_read_storage/">
|
||||
|
||||
<a href="../examples/05_read_storage/">
|
||||
|
||||
@@ -313,7 +298,7 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="chapter " data-level="3.7" data-path="../examples/06_craft_extrinsic/">
|
||||
<li class="chapter " data-level="2.7" data-path="../examples/06_craft_extrinsic/">
|
||||
|
||||
<a href="../examples/06_craft_extrinsic/">
|
||||
|
||||
@@ -326,7 +311,7 @@
|
||||
|
||||
</li>
|
||||
|
||||
<li class="chapter " data-level="3.8" data-path="../examples/07_transfer_dots/">
|
||||
<li class="chapter " data-level="2.8" data-path="../examples/07_transfer_dots/">
|
||||
|
||||
<a href="../examples/07_transfer_dots/">
|
||||
|
||||
@@ -341,26 +326,6 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="header">Contributing</li>
|
||||
|
||||
|
||||
|
||||
<li class="chapter " data-level="4.1" data-path="../CONTRIBUTING.html">
|
||||
|
||||
<a href="../CONTRIBUTING.html">
|
||||
|
||||
|
||||
Contributing guide
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="divider"></li>
|
||||
|
||||
@@ -418,476 +383,6 @@
|
||||
|
||||
<span class="hljs-built_in">console</span>.log(<span class="hljs-string">'clientVersion'</span>, version);
|
||||
</code></pre>
|
||||
<h2 id="index">Index</h2>
|
||||
<h3 id="classes">Classes</h3>
|
||||
<ul>
|
||||
<li><a href="classes/httpprovider.md">HttpProvider</a></li>
|
||||
<li><a href="classes/wsprovider.md">WsProvider</a></li>
|
||||
</ul>
|
||||
<h3 id="interfaces">Interfaces</h3>
|
||||
<ul>
|
||||
<li><a href="interfaces/providerinterface.md">ProviderInterface</a></li>
|
||||
</ul>
|
||||
<h3 id="type-aliases">Type aliases</h3>
|
||||
<ul>
|
||||
<li><a href="#httpstate">HttpState</a></li>
|
||||
<li><a href="#jsonrpcobject">JsonRpcObject</a></li>
|
||||
<li><a href="#jsonrpcrequest">JsonRpcRequest</a></li>
|
||||
<li><a href="#jsonrpcresponse">JsonRpcResponse</a></li>
|
||||
<li><a href="#jsonrpcresponsebase">JsonRpcResponseBase</a></li>
|
||||
<li><a href="#jsonrpcresponsebase_error">JsonRpcResponseBase$Error</a></li>
|
||||
<li><a href="#mockstate">MockState</a></li>
|
||||
<li><a href="#mockstate_requests">MockState$Requests</a></li>
|
||||
<li><a href="#mockstate_storage">MockState$Storage</a></li>
|
||||
<li><a href="#mockstate_subscription_callback">MockState$Subscription$Callback</a></li>
|
||||
<li><a href="#mockstate_subscriptions">MockState$Subscriptions</a></li>
|
||||
<li><a href="#providerinterface_callback">ProviderInterface$Callback</a></li>
|
||||
<li><a href="#providerinterface_emitcb">ProviderInterface$EmitCb</a></li>
|
||||
<li><a href="#providerinterface_emitted">ProviderInterface$Emitted</a></li>
|
||||
<li><a href="#rpccoder">RpcCoder</a></li>
|
||||
<li><a href="#rpccoderstate">RpcCoderState</a></li>
|
||||
</ul>
|
||||
<h3 id="functions">Functions</h3>
|
||||
<ul>
|
||||
<li><a href="#decoderesponse">decodeResponse</a></li>
|
||||
<li><a href="#encodejson">encodeJson</a></li>
|
||||
<li><a href="#encodeobject">encodeObject</a></li>
|
||||
<li><a href="#mockprovider">mockProvider</a></li>
|
||||
<li><a href="#mocks">mocks</a></li>
|
||||
<li><a href="#on">on</a></li>
|
||||
<li><a href="#rpccoder">rpcCoder</a></li>
|
||||
<li><a href="#send">send</a></li>
|
||||
<li><a href="#state">state</a></li>
|
||||
<li><a href="#subscribe">subscribe</a></li>
|
||||
<li><a href="#unsubscribe">unsubscribe</a></li>
|
||||
</ul>
|
||||
<hr>
|
||||
<h2 id="type-aliases">Type aliases</h2>
|
||||
<p><a id="httpstate"></a></p>
|
||||
<h3 id="httpstate">HttpState</h3>
|
||||
<p><strong>Ƭ HttpState</strong>: <em><code>object</code></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/http/types.d.ts#L8" target="_blank">http/types.d.ts:8</a></em></p>
|
||||
<h4 id="type-declaration">Type declaration</h4>
|
||||
<hr>
|
||||
<p><a id="jsonrpcobject"></a></p>
|
||||
<h3 id="jsonrpcobject">JsonRpcObject</h3>
|
||||
<p><strong>Ƭ JsonRpcObject</strong>: <em><code>object</code></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/types.d.ts#L5" target="_blank">types.d.ts:5</a></em></p>
|
||||
<h4 id="type-declaration">Type declaration</h4>
|
||||
<hr>
|
||||
<p><a id="jsonrpcrequest"></a></p>
|
||||
<h3 id="jsonrpcrequest">JsonRpcRequest</h3>
|
||||
<p><strong>Ƭ JsonRpcRequest</strong>: <em> <a href="#jsonrpcobject">JsonRpcObject</a> & <code>object</code>
|
||||
</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/types.d.ts#L10" target="_blank">types.d.ts:10</a></em></p>
|
||||
<hr>
|
||||
<p><a id="jsonrpcresponse"></a></p>
|
||||
<h3 id="jsonrpcresponse">JsonRpcResponse</h3>
|
||||
<p><strong>Ƭ JsonRpcResponse</strong>: <em> <a href="#jsonrpcobject">JsonRpcObject</a> & <a href="#jsonrpcresponsebase">JsonRpcResponseBase</a>
|
||||
</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/types.d.ts#L36" target="_blank">types.d.ts:36</a></em></p>
|
||||
<hr>
|
||||
<p><a id="jsonrpcresponsebase"></a></p>
|
||||
<h3 id="jsonrpcresponsebase">JsonRpcResponseBase</h3>
|
||||
<p><strong>Ƭ JsonRpcResponseBase</strong>: <em> <code>JsonRpcResponse$Single</code> & <code>JsonRpcResponse$Subscription</code>
|
||||
</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/types.d.ts#L34" target="_blank">types.d.ts:34</a></em></p>
|
||||
<hr>
|
||||
<p><a id="jsonrpcresponsebase_error"></a></p>
|
||||
<h3 id="jsonrpcresponsebaseerror">JsonRpcResponseBase$Error</h3>
|
||||
<p><strong>Ƭ JsonRpcResponseBase$Error</strong>: <em><code>object</code></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/types.d.ts#L15" target="_blank">types.d.ts:15</a></em></p>
|
||||
<h4 id="type-declaration">Type declaration</h4>
|
||||
<hr>
|
||||
<p><a id="mockstate"></a></p>
|
||||
<h3 id="mockstate">MockState</h3>
|
||||
<p><strong>Ƭ MockState</strong>: <em><code>object</code></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/mock/types.d.ts#L27" target="_blank">mock/types.d.ts:27</a></em></p>
|
||||
<h4 id="type-declaration">Type declaration</h4>
|
||||
<hr>
|
||||
<p><a id="mockstate_requests"></a></p>
|
||||
<h3 id="mockstaterequests">MockState$Requests</h3>
|
||||
<p><strong>Ƭ MockState$Requests</strong>: <em><code>object</code></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/mock/types.d.ts#L23" target="_blank">mock/types.d.ts:23</a></em></p>
|
||||
<h4 id="type-declaration">Type declaration</h4>
|
||||
<p>▸(storage: <em><a href="#mockstate_storage">MockState$Storage</a></em>, params: <em><code>Array</code><<code>any</code>></em>): <code>string</code></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Param</th>
|
||||
<th>Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>storage</td>
|
||||
<td><a href="#mockstate_storage">MockState$Storage</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>params</td>
|
||||
<td><code>Array</code><<code>any</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
<p><a id="mockstate_storage"></a></p>
|
||||
<h3 id="mockstatestorage">MockState$Storage</h3>
|
||||
<p><strong>Ƭ MockState$Storage</strong>: <em><code>object</code></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/mock/types.d.ts#L19" target="_blank">mock/types.d.ts:19</a></em></p>
|
||||
<h4 id="type-declaration">Type declaration</h4>
|
||||
<hr>
|
||||
<p><a id="mockstate_subscription_callback"></a></p>
|
||||
<h3 id="mockstatesubscriptioncallback">MockState$Subscription$Callback</h3>
|
||||
<p><strong>Ƭ MockState$Subscription$Callback</strong>: <em><code>function</code></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/mock/types.d.ts#L8" target="_blank">mock/types.d.ts:8</a></em></p>
|
||||
<h4 id="type-declaration">Type declaration</h4>
|
||||
<p>▸(error: <em> <code>Error</code> | <code>null</code></em>, value: <em><code>any</code></em>): <code>void</code></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Param</th>
|
||||
<th>Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>error</td>
|
||||
<td><code>Error</code> | <code>null</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>value</td>
|
||||
<td><code>any</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Returns:</strong> <code>void</code></p>
|
||||
<hr>
|
||||
<p><a id="mockstate_subscriptions"></a></p>
|
||||
<h3 id="mockstatesubscriptions">MockState$Subscriptions</h3>
|
||||
<p><strong>Ƭ MockState$Subscriptions</strong>: <em><code>object</code></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/mock/types.d.ts#L10" target="_blank">mock/types.d.ts:10</a></em></p>
|
||||
<h4 id="type-declaration">Type declaration</h4>
|
||||
<hr>
|
||||
<p><a id="providerinterface_callback"></a></p>
|
||||
<h3 id="providerinterfacecallback">ProviderInterface$Callback</h3>
|
||||
<p><strong>Ƭ ProviderInterface$Callback</strong>: <em><code>function</code></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/types.d.ts#L38" target="_blank">types.d.ts:38</a></em></p>
|
||||
<h4 id="type-declaration">Type declaration</h4>
|
||||
<p>▸(error: <em> <code>Error</code> | <code>null</code></em>, result: <em><code>any</code></em>): <code>void</code></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Param</th>
|
||||
<th>Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>error</td>
|
||||
<td><code>Error</code> | <code>null</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>result</td>
|
||||
<td><code>any</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Returns:</strong> <code>void</code></p>
|
||||
<hr>
|
||||
<p><a id="providerinterface_emitcb"></a></p>
|
||||
<h3 id="providerinterfaceemitcb">ProviderInterface$EmitCb</h3>
|
||||
<p><strong>Ƭ ProviderInterface$EmitCb</strong>: <em><code>function</code></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/types.d.ts#L42" target="_blank">types.d.ts:42</a></em></p>
|
||||
<h4 id="type-declaration">Type declaration</h4>
|
||||
<p>▸(value?: <em><code>any</code></em>): <code>any</code></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Param</th>
|
||||
<th>Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Optional</code> value</td>
|
||||
<td><code>any</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Returns:</strong> <code>any</code></p>
|
||||
<hr>
|
||||
<p><a id="providerinterface_emitted"></a></p>
|
||||
<h3 id="providerinterfaceemitted">ProviderInterface$Emitted</h3>
|
||||
<p><strong>Ƭ ProviderInterface$Emitted</strong>: <em> "connected" | "disconnected"
|
||||
</em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/types.d.ts#L40" target="_blank">types.d.ts:40</a></em></p>
|
||||
<hr>
|
||||
<p><a id="rpccoder"></a></p>
|
||||
<h3 id="rpccoder">RpcCoder</h3>
|
||||
<p><strong>Ƭ RpcCoder</strong>: <em><code>object</code></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/coder/json/types.d.ts#L7" target="_blank">coder/json/types.d.ts:7</a></em></p>
|
||||
<h4 id="type-declaration">Type declaration</h4>
|
||||
<hr>
|
||||
<p><a id="rpccoderstate"></a></p>
|
||||
<h3 id="rpccoderstate">RpcCoderState</h3>
|
||||
<p><strong>Ƭ RpcCoderState</strong>: <em><code>object</code></em></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/coder/json/types.d.ts#L14" target="_blank">coder/json/types.d.ts:14</a></em></p>
|
||||
<h4 id="type-declaration">Type declaration</h4>
|
||||
<hr>
|
||||
<h2 id="functions">Functions</h2>
|
||||
<p><a id="decoderesponse"></a></p>
|
||||
<h3 id="decoderesponse">decodeResponse</h3>
|
||||
<p>▸ <strong>decodeResponse</strong>(self: <em><a href="#rpccoderstate">RpcCoderState</a></em>, response: <em><a href="#jsonrpcresponse">JsonRpcResponse</a></em>): <code>any</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/coder/json/decodeResponse.ts#L22" target="_blank">coder/json/decodeResponse.ts:22</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Param</th>
|
||||
<th>Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>self</td>
|
||||
<td><a href="#rpccoderstate">RpcCoderState</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>response</td>
|
||||
<td><a href="#jsonrpcresponse">JsonRpcResponse</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Returns:</strong> <code>any</code></p>
|
||||
<hr>
|
||||
<p><a id="encodejson"></a></p>
|
||||
<h3 id="encodejson">encodeJson</h3>
|
||||
<p>▸ <strong>encodeJson</strong>(self: <em><a href="#rpccoderstate">RpcCoderState</a></em>, method: <em><code>string</code></em>, params: <em><code>Array</code><<code>any</code>></em>): <code>string</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/coder/json/encodeJson.ts#L9" target="_blank">coder/json/encodeJson.ts:9</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Param</th>
|
||||
<th>Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>self</td>
|
||||
<td><a href="#rpccoderstate">RpcCoderState</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>method</td>
|
||||
<td><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>params</td>
|
||||
<td><code>Array</code><<code>any</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Returns:</strong> <code>string</code></p>
|
||||
<hr>
|
||||
<p><a id="encodeobject"></a></p>
|
||||
<h3 id="encodeobject">encodeObject</h3>
|
||||
<p>▸ <strong>encodeObject</strong>(self: <em><a href="#rpccoderstate">RpcCoderState</a></em>, method: <em><code>string</code></em>, params: <em><code>Array</code><<code>any</code>></em>): <a href="#jsonrpcrequest">JsonRpcRequest</a></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/coder/json/encodeObject.ts#L8" target="_blank">coder/json/encodeObject.ts:8</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Param</th>
|
||||
<th>Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>self</td>
|
||||
<td><a href="#rpccoderstate">RpcCoderState</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>method</td>
|
||||
<td><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>params</td>
|
||||
<td><code>Array</code><<code>any</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Returns:</strong> <a href="#jsonrpcrequest">JsonRpcRequest</a></p>
|
||||
<hr>
|
||||
<p><a id="mockprovider"></a></p>
|
||||
<h3 id="mockprovider">mockProvider</h3>
|
||||
<p>▸ <strong>mockProvider</strong>(): <a href="interfaces/providerinterface.md">ProviderInterface</a></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/mock/index.ts#L18" target="_blank">mock/index.ts:18</a></em></p>
|
||||
<p>A moock provider mainly used for testing.</p>
|
||||
<p><strong>Returns:</strong> <a href="interfaces/providerinterface.md">ProviderInterface</a>
|
||||
The mock provider</p>
|
||||
<hr>
|
||||
<p><a id="mocks"></a></p>
|
||||
<h3 id="mocks">mocks</h3>
|
||||
<p>▸ <strong>mocks</strong>(__namedParameters: <em><code>object</code></em>): <code>void</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/mock/mocks.ts#L68" target="_blank">mock/mocks.ts:68</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Param</th>
|
||||
<th>Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>__namedParameters</td>
|
||||
<td><code>object</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Returns:</strong> <code>void</code></p>
|
||||
<hr>
|
||||
<p><a id="on"></a></p>
|
||||
<h3 id="on">on</h3>
|
||||
<p>▸ <strong>on</strong>(self: <em><a href="#mockstate">MockState</a></em>, type: <em><a href="#providerinterface_emitted">ProviderInterface$Emitted</a></em>, sub: <em><a href="#providerinterface_emitcb">ProviderInterface$EmitCb</a></em>): <code>void</code></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/mock/on.ts#L8" target="_blank">mock/on.ts:8</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Param</th>
|
||||
<th>Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>self</td>
|
||||
<td><a href="#mockstate">MockState</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>type</td>
|
||||
<td><a href="#providerinterface_emitted">ProviderInterface$Emitted</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>sub</td>
|
||||
<td><a href="#providerinterface_emitcb">ProviderInterface$EmitCb</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Returns:</strong> <code>void</code></p>
|
||||
<hr>
|
||||
<p><a id="rpccoder"></a></p>
|
||||
<h3 id="rpccoder">rpcCoder</h3>
|
||||
<p>▸ <strong>rpcCoder</strong>(): <a href="#rpccoder">RpcCoder</a></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/coder/json/index.ts#L12" target="_blank">coder/json/index.ts:12</a></em></p>
|
||||
<p><strong>Returns:</strong> <a href="#rpccoder">RpcCoder</a></p>
|
||||
<hr>
|
||||
<p><a id="send"></a></p>
|
||||
<h3 id="send">send</h3>
|
||||
<p>▸ <strong>send</strong>(__namedParameters: <em><code>object</code></em>, method: <em><code>string</code></em>, params: <em><code>Array</code><<code>any</code>></em>): <code>Promise</code><<code>any</code>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/mock/send.ts#L7" target="_blank">mock/send.ts:7</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Param</th>
|
||||
<th>Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>__namedParameters</td>
|
||||
<td><code>object</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>method</td>
|
||||
<td><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>params</td>
|
||||
<td><code>Array</code><<code>any</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Returns:</strong> <code>Promise</code><<code>any</code>></p>
|
||||
<hr>
|
||||
<p><a id="state"></a></p>
|
||||
<h3 id="state">state</h3>
|
||||
<p>▸ <strong>state</strong>(): <a href="#mockstate">MockState</a></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/mock/state.ts#L38" target="_blank">mock/state.ts:38</a></em></p>
|
||||
<p><strong>Returns:</strong> <a href="#mockstate">MockState</a></p>
|
||||
<hr>
|
||||
<p><a id="subscribe"></a></p>
|
||||
<h3 id="subscribe">subscribe</h3>
|
||||
<p>▸ <strong>subscribe</strong>(self: <em><a href="#mockstate">MockState</a></em>, type: <em><code>string</code></em>, method: <em><code>string</code></em>, params: <em><code>Array</code><<code>any</code>></em>): <code>Promise</code><<code>number</code>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/mock/subscribe.ts#L7" target="_blank">mock/subscribe.ts:7</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Param</th>
|
||||
<th>Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>self</td>
|
||||
<td><a href="#mockstate">MockState</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>type</td>
|
||||
<td><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>method</td>
|
||||
<td><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>params</td>
|
||||
<td><code>Array</code><<code>any</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Returns:</strong> <code>Promise</code><<code>number</code>></p>
|
||||
<hr>
|
||||
<p><a id="unsubscribe"></a></p>
|
||||
<h3 id="unsubscribe">unsubscribe</h3>
|
||||
<p>▸ <strong>unsubscribe</strong>(self: <em><a href="#mockstate">MockState</a></em>, type: <em><code>string</code></em>, name: <em><code>string</code></em>, id: <em><code>number</code></em>): <code>Promise</code><<code>boolean</code>></p>
|
||||
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-provider/src/mock/unsubscribe.ts#L7" target="_blank">mock/unsubscribe.ts:7</a></em></p>
|
||||
<p><strong>Parameters:</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Param</th>
|
||||
<th>Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>self</td>
|
||||
<td><a href="#mockstate">MockState</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>type</td>
|
||||
<td><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>name</td>
|
||||
<td><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>id</td>
|
||||
<td><code>number</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Returns:</strong> <code>Promise</code><<code>boolean</code>></p>
|
||||
<hr>
|
||||
|
||||
|
||||
</section>
|
||||
@@ -915,12 +410,12 @@ The mock provider</p>
|
||||
|
||||
|
||||
|
||||
<a href="../api-format/" class="navigation navigation-prev " aria-label="Previous page: api-format">
|
||||
<a href="../api/classes/_index_.api.html" class="navigation navigation-prev " aria-label="Previous page: Api">
|
||||
<i class="fa fa-angle-left"></i>
|
||||
</a>
|
||||
|
||||
|
||||
<a href="../api-rx/" class="navigation navigation-next " aria-label="Next page: api-rx">
|
||||
<a href="classes/_http_index_.httpprovider.html" class="navigation navigation-next " aria-label="Next page: HttpProvider">
|
||||
<i class="fa fa-angle-right"></i>
|
||||
</a>
|
||||
|
||||
@@ -931,7 +426,7 @@ The mock provider</p>
|
||||
<script>
|
||||
var gitbook = gitbook || [];
|
||||
gitbook.push(function() {
|
||||
gitbook.page.hasChanged({"page":{"title":"api-provider","level":"2.3","depth":1,"next":{"title":"api-rx","level":"2.4","depth":1,"path":"api-rx/README.md","ref":"api-rx/README.md","articles":[]},"previous":{"title":"api-format","level":"2.2","depth":1,"path":"api-format/README.md","ref":"api-format/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["asciidoc-include"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"asciidoc-include":{"syntax":"asciidoc"},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api-provider/README.md","mtime":"2018-09-17T12:35:52.445Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-09-17T12:37:27.221Z"},"basePath":"..","book":{"language":""}});
|
||||
gitbook.page.hasChanged({"page":{"title":"api-provider","level":"1.3","depth":1,"next":{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"api-provider/classes/_http_index_.httpprovider.md","ref":"api-provider/classes/_http_index_.httpprovider.md","articles":[]},"previous":{"title":"Api","level":"1.2.1","depth":2,"path":"api/classes/_index_.api.md","ref":"api/classes/_index_.api.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api-provider/README.md","mtime":"2018-09-19T11:17:52.103Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-09-19T11:17:59.884Z"},"basePath":"..","book":{"language":""}});
|
||||
});
|
||||
</script>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user