Skip to content

Commit

Permalink
[CI Skip] 0.30.2
Browse files Browse the repository at this point in the history
  • Loading branch information
Travis CI committed Sep 28, 2018
1 parent 74737b6 commit 62ed0a7
Show file tree
Hide file tree
Showing 52 changed files with 514 additions and 532 deletions.
2 changes: 1 addition & 1 deletion docs/GLOSSARY.html
View file
Expand Up @@ -402,7 +402,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"GLOSSARY.md","mtime":"2018-09-27T11:13:50.022Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-09-27T11:17:41.057Z"},"basePath":".","book":{"language":""}});
gitbook.page.hasChanged({"page":{"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"GLOSSARY.md","mtime":"2018-09-28T13:42:47.732Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-09-28T13:47:55.661Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
Expand Down
22 changes: 9 additions & 13 deletions docs/api-provider/classes/_http_index_.httpprovider.html
View file
Expand Up @@ -370,12 +370,8 @@ <h1>
<section class="normal markdown-section">

<p>The HTTP Provider allows sending requests using HTTP. it does not support subscriptions so you won&#xB4;t be able to listen to events such as new blocks or balance changes. It is usually preferrable using the <a href="_ws_index_.wsprovider.html">WsProvider</a>.
<em><strong>example</strong></em>: ```javascript
import createApi from &apos;@polkadot/api&apos;;
import WsProvider from &apos;@polkadot/api-provider/ws&apos;;</p>
<p>const provider = new WsProvider(&apos;<a href="http://127.0.0.1:9933" target="_blank">http://127.0.0.1:9933</a>&apos;);
const api = createApi(provider);
```</p>
<em><strong>example</strong></em>: import createApi from &apos;@polkadot/api&apos;; import WsProvider from &apos;@polkadot/api-provider/ws&apos;;</p>
<p>const provider = new WsProvider(&apos;<a href="http://127.0.0.1:9933&apos;" target="_blank">http://127.0.0.1:9933&apos;)</a>); const api = createApi(provider);</p>
<p><em><strong>see</strong></em>: <a href="_ws_index_.wsprovider.html">WsProvider</a></p>
<h1 id="hierarchy">Hierarchy</h1>
<p><strong>HttpProvider</strong></p>
Expand All @@ -387,7 +383,7 @@ <h1 id="constructors">Constructors</h1>
<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/170c337/packages/api-provider/src/http/index.ts#L36" target="_blank">http/index.ts:36</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/74737b6/packages/api-provider/src/http/index.ts#L35" target="_blank">http/index.ts:35</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
Expand All @@ -410,7 +406,7 @@ <h1 id="methods">Methods</h1>
<h2 id="isconnected">isConnected</h2>
<p>&#x25B8; <strong>isConnected</strong>(): <code>boolean</code></p>
<p><em>Implementation of <a href="../interfaces/_types_d_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_d_.providerinterface.md#isconnected">isConnected</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/170c337/packages/api-provider/src/http/index.ts#L50" target="_blank">http/index.ts:50</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/74737b6/packages/api-provider/src/http/index.ts#L49" target="_blank">http/index.ts:49</a></em></p>
<p>Whether the node is connected or not.</p>
<p><strong>Returns:</strong> <code>boolean</code>
true if connected</p>
Expand All @@ -419,7 +415,7 @@ <h2 id="isconnected">isConnected</h2>
<h2 id="on">on</h2>
<p>&#x25B8; <strong>on</strong>(type: <em><a href="../modules/_types_d_.md#providerinterface_emitted">ProviderInterface$Emitted</a></em>, sub: <em><a href="../modules/_types_d_.md#providerinterface_emitcb">ProviderInterface$EmitCb</a></em>): <code>void</code></p>
<p><em>Implementation of <a href="../interfaces/_types_d_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_d_.providerinterface.md#on">on</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/170c337/packages/api-provider/src/http/index.ts#L57" target="_blank">http/index.ts:57</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/74737b6/packages/api-provider/src/http/index.ts#L56" target="_blank">http/index.ts:56</a></em></p>
<p>Events are not supported with the HttpProvider, see <a href="_ws_index_.wsprovider.html">WsProvider</a>.</p>
<p><strong>Parameters:</strong></p>
<table>
Expand All @@ -446,7 +442,7 @@ <h2 id="on">on</h2>
<h2 id="send">send</h2>
<p>&#x25B8; <strong>send</strong>(method: <em><code>string</code></em>, params: <em><code>Array</code>&lt;<code>any</code>&gt;</em>): <code>Promise</code>&lt;<code>any</code>&gt;</p>
<p><em>Implementation of <a href="../interfaces/_types_d_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_d_.providerinterface.md#send">send</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/170c337/packages/api-provider/src/http/index.ts#L61" target="_blank">http/index.ts:61</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/74737b6/packages/api-provider/src/http/index.ts#L60" target="_blank">http/index.ts:60</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
Expand All @@ -472,7 +468,7 @@ <h2 id="send">send</h2>
<h2 id="subscribe">subscribe</h2>
<p>&#x25B8; <strong>subscribe</strong>(types: <em><code>string</code></em>, method: <em><code>string</code></em>, params: <em><code>Array</code>&lt;<code>any</code>&gt;</em>, cb: <em><a href="../modules/_types_d_.md#providerinterface_callback">ProviderInterface$Callback</a></em>): <code>Promise</code>&lt;<code>number</code>&gt;</p>
<p><em>Implementation of <a href="../interfaces/_types_d_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_d_.providerinterface.md#subscribe">subscribe</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/170c337/packages/api-provider/src/http/index.ts#L83" target="_blank">http/index.ts:83</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/74737b6/packages/api-provider/src/http/index.ts#L82" target="_blank">http/index.ts:82</a></em></p>
<p>Subscriptions are not supported with the HttpProvider, see <a href="_ws_index_.wsprovider.html">WsProvider</a>.</p>
<p><strong>Parameters:</strong></p>
<table>
Expand Down Expand Up @@ -507,7 +503,7 @@ <h2 id="subscribe">subscribe</h2>
<h2 id="unsubscribe">unsubscribe</h2>
<p>&#x25B8; <strong>unsubscribe</strong>(type: <em><code>string</code></em>, method: <em><code>string</code></em>, id: <em><code>number</code></em>): <code>Promise</code>&lt;<code>boolean</code>&gt;</p>
<p><em>Implementation of <a href="../interfaces/_types_d_.providerinterface.md">ProviderInterface</a>.<a href="../interfaces/_types_d_.providerinterface.md#unsubscribe">unsubscribe</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/170c337/packages/api-provider/src/http/index.ts#L92" target="_blank">http/index.ts:92</a></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/74737b6/packages/api-provider/src/http/index.ts#L91" target="_blank">http/index.ts:91</a></em></p>
<p>Subscriptions are not supported with the HttpProvider, see <a href="_ws_index_.wsprovider.html">WsProvider</a>.</p>
<p><strong>Parameters:</strong></p>
<table>
Expand Down Expand Up @@ -577,7 +573,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"HttpProvider","level":"1.3.1","depth":2,"next":{"title":"WsProvider","level":"1.3.2","depth":2,"path":"api-provider/classes/_ws_index_.wsprovider.md","ref":"api-provider/classes/_ws_index_.wsprovider.md","articles":[]},"previous":{"title":"api-provider","level":"1.3","depth":1,"path":"api-provider/README.md","ref":"api-provider/README.md","articles":[{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"api-provider/classes/_http_index_.httpprovider.md","ref":"api-provider/classes/_http_index_.httpprovider.md","articles":[]},{"title":"WsProvider","level":"1.3.2","depth":2,"path":"api-provider/classes/_ws_index_.wsprovider.md","ref":"api-provider/classes/_ws_index_.wsprovider.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api-provider/classes/_http_index_.httpprovider.md","mtime":"2018-09-27T11:17:01.801Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-09-27T11:17:41.057Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"HttpProvider","level":"1.3.1","depth":2,"next":{"title":"WsProvider","level":"1.3.2","depth":2,"path":"api-provider/classes/_ws_index_.wsprovider.md","ref":"api-provider/classes/_ws_index_.wsprovider.md","articles":[]},"previous":{"title":"api-provider","level":"1.3","depth":1,"path":"api-provider/README.md","ref":"api-provider/README.md","articles":[{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"api-provider/classes/_http_index_.httpprovider.md","ref":"api-provider/classes/_http_index_.httpprovider.md","articles":[]},{"title":"WsProvider","level":"1.3.2","depth":2,"path":"api-provider/classes/_ws_index_.wsprovider.md","ref":"api-provider/classes/_ws_index_.wsprovider.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api-provider/classes/_http_index_.httpprovider.md","mtime":"2018-09-28T13:47:08.449Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-09-28T13:47:55.661Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
Expand Down
20 changes: 8 additions & 12 deletions docs/api-provider/classes/_http_index_.httpprovider.md
View file
@@ -1,13 +1,9 @@


The HTTP Provider allows sending requests using HTTP. it does not support subscriptions so you won´t be able to listen to events such as new blocks or balance changes. It is usually preferrable using the [WsProvider](_ws_index_.wsprovider.md).
*__example__*: ```javascript
import createApi from '@polkadot/api';
import WsProvider from '@polkadot/api-provider/ws';
*__example__*: import createApi from '@polkadot/api'; import WsProvider from '@polkadot/api-provider/ws';

const provider = new WsProvider('http://127.0.0.1:9933');
const api = createApi(provider);
```
const provider = new WsProvider('[http://127.0.0.1:9933')](http://127.0.0.1:9933')); const api = createApi(provider);

*__see__*: [WsProvider](_ws_index_.wsprovider.md)

Expand All @@ -27,7 +23,7 @@ const api = createApi(provider);

⊕ **new HttpProvider**(endpoint: *`string`*): [HttpProvider](_http_index_.httpprovider.md)

*Defined in [http/index.ts:36](https://github.com/polkadot-js/api/blob/170c337/packages/api-provider/src/http/index.ts#L36)*
*Defined in [http/index.ts:35](https://github.com/polkadot-js/api/blob/74737b6/packages/api-provider/src/http/index.ts#L35)*

**Parameters:**

Expand All @@ -49,7 +45,7 @@ ___

*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[isConnected](../interfaces/_types_d_.providerinterface.md#isconnected)*

*Defined in [http/index.ts:50](https://github.com/polkadot-js/api/blob/170c337/packages/api-provider/src/http/index.ts#L50)*
*Defined in [http/index.ts:49](https://github.com/polkadot-js/api/blob/74737b6/packages/api-provider/src/http/index.ts#L49)*

Whether the node is connected or not.

Expand All @@ -65,7 +61,7 @@ ___

*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[on](../interfaces/_types_d_.providerinterface.md#on)*

*Defined in [http/index.ts:57](https://github.com/polkadot-js/api/blob/170c337/packages/api-provider/src/http/index.ts#L57)*
*Defined in [http/index.ts:56](https://github.com/polkadot-js/api/blob/74737b6/packages/api-provider/src/http/index.ts#L56)*

Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).

Expand All @@ -87,7 +83,7 @@ ___

*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[send](../interfaces/_types_d_.providerinterface.md#send)*

*Defined in [http/index.ts:61](https://github.com/polkadot-js/api/blob/170c337/packages/api-provider/src/http/index.ts#L61)*
*Defined in [http/index.ts:60](https://github.com/polkadot-js/api/blob/74737b6/packages/api-provider/src/http/index.ts#L60)*

**Parameters:**

Expand All @@ -107,7 +103,7 @@ ___

*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[subscribe](../interfaces/_types_d_.providerinterface.md#subscribe)*

*Defined in [http/index.ts:83](https://github.com/polkadot-js/api/blob/170c337/packages/api-provider/src/http/index.ts#L83)*
*Defined in [http/index.ts:82](https://github.com/polkadot-js/api/blob/74737b6/packages/api-provider/src/http/index.ts#L82)*

Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).

Expand All @@ -131,7 +127,7 @@ ___

*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[unsubscribe](../interfaces/_types_d_.providerinterface.md#unsubscribe)*

*Defined in [http/index.ts:92](https://github.com/polkadot-js/api/blob/170c337/packages/api-provider/src/http/index.ts#L92)*
*Defined in [http/index.ts:91](https://github.com/polkadot-js/api/blob/74737b6/packages/api-provider/src/http/index.ts#L91)*

Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).

Expand Down

0 comments on commit 62ed0a7

Please sign in to comment.