- 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.
-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);
-see: WsProvider
+ name: HttpProvider
+summary: The HTTP Provider allows sending requests using HTTP.
+description: 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.
+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);
+
see: WsProvider
Hierarchy
HttpProvider
Implements
@@ -383,19 +389,21 @@
constructor
⊕ new HttpProvider(endpoint: string): HttpProvider
-Defined in http/index.ts:35
+Defined in http/index.ts:38
Parameters:
| Param |
Type |
+Description |
| endpoint |
string |
+The endpoint url starting with http:// |
@@ -406,8 +414,8 @@
isConnected
▸ isConnected(): boolean
Implementation of ProviderInterface.isConnected
-Defined in http/index.ts:49
-Whether the node is connected or not.
+Defined in http/index.ts:55
+summary: Whether the node is connected or not.
Returns: boolean
true if connected
@@ -415,8 +423,9 @@ true if connected
on
▸ on(type: ProviderInterface$Emitted, sub: ProviderInterface$EmitCb): void
Implementation of ProviderInterface.on
-Defined in http/index.ts:56
-Events are not supported with the HttpProvider, see WsProvider.
+Defined in http/index.ts:63
+summary: Events are not supported with the HttpProvider, see WsProvider.
+description: HTTP Provider does not have 'on' emitters. WebSockets should be used instead.
Parameters:
@@ -442,7 +451,8 @@ true if connected
send
▸ send(method: string, params: Array<any>): Promise<any>
Implementation of ProviderInterface.send
-Defined in http/index.ts:60
+Defined in http/index.ts:70
+summary: Send HTTP POST Request with Body to configured HTTP Endpoint.
Parameters:
@@ -468,8 +478,8 @@ true if connected
subscribe
▸ subscribe(types: string, method: string, params: Array<any>, cb: ProviderInterface$Callback): Promise<number>
Implementation of ProviderInterface.subscribe
-Defined in http/index.ts:82
-Subscriptions are not supported with the HttpProvider, see WsProvider.
+Defined in http/index.ts:92
+summary: Subscriptions are not supported with the HttpProvider, see WsProvider.
Parameters:
@@ -503,8 +513,8 @@ true if connected
unsubscribe
▸ unsubscribe(type: string, method: string, id: number): Promise<boolean>
Implementation of ProviderInterface.unsubscribe
-Defined in http/index.ts:91
-Subscriptions are not supported with the HttpProvider, see WsProvider.
+Defined in http/index.ts:101
+summary: Subscriptions are not supported with the HttpProvider, see WsProvider.
Parameters:
@@ -573,7 +583,7 @@ true if connected
diff --git a/docs/api-provider/classes/_http_index_.httpprovider.md b/docs/api-provider/classes/_http_index_.httpprovider.md
index 57a95137c2..524e2402a6 100644
--- a/docs/api-provider/classes/_http_index_.httpprovider.md
+++ b/docs/api-provider/classes/_http_index_.httpprovider.md
@@ -1,9 +1,20 @@
-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__*: import createApi from '@polkadot/api'; import WsProvider from '@polkadot/api-provider/ws';
+*__name__*: HttpProvider
-const provider = new WsProvider('[http://127.0.0.1:9933')](http://127.0.0.1:9933')); const api = createApi(provider);
+*__summary__*: The HTTP Provider allows sending requests using HTTP.
+
+*__description__*: 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__*:
+
+```
+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);
+```
*__see__*: [WsProvider](_ws_index_.wsprovider.md)
@@ -23,13 +34,13 @@ const provider = new WsProvider('[http://127.0.0.1:9933')](http://127.0.0.1:9933
⊕ **new HttpProvider**(endpoint: *`string`*): [HttpProvider](_http_index_.httpprovider.md)
-*Defined in [http/index.ts:35](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/http/index.ts#L35)*
+*Defined in [http/index.ts:38](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/http/index.ts#L38)*
**Parameters:**
-| Param | Type |
-| ------ | ------ |
-| endpoint | `string` |
+| Param | Type | Description |
+| ------ | ------ | ------ |
+| endpoint | `string` | The endpoint url starting with http:// |
**Returns:** [HttpProvider](_http_index_.httpprovider.md)
@@ -45,9 +56,9 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[isConnected](../interfaces/_types_d_.providerinterface.md#isconnected)*
-*Defined in [http/index.ts:49](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/http/index.ts#L49)*
+*Defined in [http/index.ts:55](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/http/index.ts#L55)*
-Whether the node is connected or not.
+*__summary__*: Whether the node is connected or not.
**Returns:** `boolean`
true if connected
@@ -61,9 +72,11 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[on](../interfaces/_types_d_.providerinterface.md#on)*
-*Defined in [http/index.ts:56](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/http/index.ts#L56)*
+*Defined in [http/index.ts:63](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/http/index.ts#L63)*
-Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
+*__summary__*: Events are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
+
+*__description__*: HTTP Provider does not have 'on' emitters. WebSockets should be used instead.
**Parameters:**
@@ -83,7 +96,9 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[send](../interfaces/_types_d_.providerinterface.md#send)*
-*Defined in [http/index.ts:60](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/http/index.ts#L60)*
+*Defined in [http/index.ts:70](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/http/index.ts#L70)*
+
+*__summary__*: Send HTTP POST Request with Body to configured HTTP Endpoint.
**Parameters:**
@@ -103,9 +118,9 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[subscribe](../interfaces/_types_d_.providerinterface.md#subscribe)*
-*Defined in [http/index.ts:82](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/http/index.ts#L82)*
+*Defined in [http/index.ts:92](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/http/index.ts#L92)*
-Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
+*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
**Parameters:**
@@ -127,9 +142,9 @@ ___
*Implementation of [ProviderInterface](../interfaces/_types_d_.providerinterface.md).[unsubscribe](../interfaces/_types_d_.providerinterface.md#unsubscribe)*
-*Defined in [http/index.ts:91](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/http/index.ts#L91)*
+*Defined in [http/index.ts:101](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/http/index.ts#L101)*
-Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
+*__summary__*: Subscriptions are not supported with the HttpProvider, see [WsProvider](_ws_index_.wsprovider.md).
**Parameters:**
diff --git a/docs/api-provider/classes/_ws_index_.wsprovider.html b/docs/api-provider/classes/_ws_index_.wsprovider.html
index 0e7f81b44a..0b4af9722d 100644
--- a/docs/api-provider/classes/_ws_index_.wsprovider.html
+++ b/docs/api-provider/classes/_ws_index_.wsprovider.html
@@ -369,9 +369,16 @@
- The WebSocket Provider allows sending requests using WebSocket. Unlike the HttpProvider, it does support subscriptions and allows listening to events such as new blocks or balance changes.
-example: import createApi from '@polkadot/api'; import WsProvider from '@polkadot/api-provider/ws'; const provider = new WsProvider('ws://127.0.0.1:9944'); const api = createApi(provider);
-see: HttpProvider
+ name: WsProvider
+summary: The WebSocket Provider allows sending requests using WebSocket.
+description: Unlike the HttpProvider, it does support subscriptions and allows listening to events such as new blocks or balance changes.
+example:
+import createApi from '@polkadot/api';
+import WsProvider from '@polkadot/api-provider/ws';
+
+const provider = new WsProvider('ws://127.0.0.1:9944');
+const api = createApi(provider);
+
see: HttpProvider
Type parameters
EventTypes : string | symbol
Hierarchy
@@ -385,7 +392,7 @@
constructor
⊕ new WsProvider(endpoint: string, autoConnect?: boolean): WsProvider
-Defined in ws/index.ts:67
+Defined in ws/index.ts:71
Parameters:
@@ -455,8 +462,9 @@
connect
▸ connect(): void
-Defined in ws/index.ts:97
-The WsProvider connects automatically by default. if you decided otherwise, you may connect manually using this method.
+Defined in ws/index.ts:102
+summary: Manually connect
+description: The WsProvider connects automatically by default, however if you decided otherwise, you may connect manually using this method.
Returns: void
@@ -497,8 +505,8 @@
isConnected
▸ isConnected(): boolean
-Defined in ws/index.ts:114
-Whether the node is connected or not.
+Defined in ws/index.ts:119
+summary: Whether the node is connected or not.
Returns: boolean
true if connected
@@ -586,8 +594,8 @@ true if connected
on
▸ on(type: ProviderInterface$Emitted, sub: ProviderInterface$EmitCb): this
Overrides EventEmitter.on
-Defined in ws/index.ts:124
-Listens on events after having subscribed using the subscribe function.
+Defined in ws/index.ts:129
+summary: Listens on events after having subscribed using the subscribe function.
Parameters:
@@ -705,7 +713,8 @@ true if connected
send
▸ send(method: string, params: Array<any>, subscription?: SubscriptionHandler): Promise<any>
-Defined in ws/index.ts:128
+Defined in ws/index.ts:136
+summary: Send JSON data using WebSockets to configured HTTP Endpoint or queue.
Parameters:
@@ -734,12 +743,15 @@ true if connected
subscribe
▸ subscribe(type: string, method: string, params: Array<any>, callback: ProviderInterface$Callback): Promise<number>
-Defined in ws/index.ts:179
-Allows subscribing to a specific event.
-example: const provider = new WsProvider('ws://127.0.0.1:9944'); const api = createApi(provider);
-api.state.storage([[storage.balances.freeBalance,
-]], (_, values) => { console.log(values) }).then((subscriptionId) => { console.log('balance changes subscription id: ', subscriptionId) })
-Parameters:
+Defined in ws/index.ts:190
+name: subscribe
+summary: Allows subscribing to a specific event.
+example:
+const provider = new WsProvider('ws://127.0.0.1:9944');
+const api = createApi(provider);
+
+api.state.storage([[storage.balances.freeBalance,
+
Parameters:
@@ -777,8 +789,8 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
unsubscribe
▸ unsubscribe(type: string, method: string, id: number): Promise<boolean>
-Defined in ws/index.ts:188
-Allows unsubscribing to subscriptions made with subscribe.
+Defined in ws/index.ts:199
+summary: Allows unsubscribing to subscriptions made with subscribe.
Parameters:
@@ -847,7 +859,7 @@ Promise resolving to the dd of the subscription you can use with [[unsubscribe]]
diff --git a/docs/api-provider/classes/_ws_index_.wsprovider.md b/docs/api-provider/classes/_ws_index_.wsprovider.md
index d7b0aa1ac5..b9be618ea3 100644
--- a/docs/api-provider/classes/_ws_index_.wsprovider.md
+++ b/docs/api-provider/classes/_ws_index_.wsprovider.md
@@ -1,7 +1,20 @@
-The WebSocket Provider allows sending requests using WebSocket. Unlike the [HttpProvider](_http_index_.httpprovider.md), it does support subscriptions and allows listening to events such as new blocks or balance changes.
-*__example__*: import createApi from '@polkadot/api'; import WsProvider from '@polkadot/api-provider/ws'; const provider = new WsProvider('ws://127.0.0.1:9944'); const api = createApi(provider);
+*__name__*: WsProvider
+
+*__summary__*: The WebSocket Provider allows sending requests using WebSocket.
+
+*__description__*: Unlike the [HttpProvider](_http_index_.httpprovider.md), it does support subscriptions and allows listening to events such as new blocks or balance changes.
+
+*__example__*:
+
+```
+import createApi from '@polkadot/api';
+import WsProvider from '@polkadot/api-provider/ws';
+
+const provider = new WsProvider('ws://127.0.0.1:9944');
+const api = createApi(provider);
+```
*__see__*: [HttpProvider](_http_index_.httpprovider.md)
@@ -26,7 +39,7 @@ The WebSocket Provider allows sending requests using WebSocket. Unlike the [Http
⊕ **new WsProvider**(endpoint: *`string`*, autoConnect?: *`boolean`*): [WsProvider](_ws_index_.wsprovider.md)
-*Defined in [ws/index.ts:67](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/ws/index.ts#L67)*
+*Defined in [ws/index.ts:71](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/ws/index.ts#L71)*
**Parameters:**
@@ -83,9 +96,11 @@ ___
▸ **connect**(): `void`
-*Defined in [ws/index.ts:97](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/ws/index.ts#L97)*
+*Defined in [ws/index.ts:102](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/ws/index.ts#L102)*
-The [WsProvider](_ws_index_.wsprovider.md) connects automatically by default. if you decided otherwise, you may connect manually using this method.
+*__summary__*: Manually connect
+
+*__description__*: The [WsProvider](_ws_index_.wsprovider.md) connects automatically by default, however if you decided otherwise, you may connect manually using this method.
**Returns:** `void`
@@ -133,9 +148,9 @@ ___
▸ **isConnected**(): `boolean`
-*Defined in [ws/index.ts:114](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/ws/index.ts#L114)*
+*Defined in [ws/index.ts:119](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/ws/index.ts#L119)*
-Whether the node is connected or not.
+*__summary__*: Whether the node is connected or not.
**Returns:** `boolean`
true if connected
@@ -213,9 +228,9 @@ ___
*Overrides EventEmitter.on*
-*Defined in [ws/index.ts:124](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/ws/index.ts#L124)*
+*Defined in [ws/index.ts:129](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/ws/index.ts#L129)*
-Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function.
+*__summary__*: Listens on events after having subscribed using the [subscribe](_ws_index_.wsprovider.md#subscribe) function.
**Parameters:**
@@ -302,7 +317,9 @@ ___
▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`>
-*Defined in [ws/index.ts:128](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/ws/index.ts#L128)*
+*Defined in [ws/index.ts:136](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/ws/index.ts#L136)*
+
+*__summary__*: Send JSON data using WebSockets to configured HTTP Endpoint or queue.
**Parameters:**
@@ -321,14 +338,20 @@ ___
▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *[ProviderInterface$Callback](../modules/_types_d_.md#providerinterface_callback)*): `Promise`<`number`>
-*Defined in [ws/index.ts:179](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/ws/index.ts#L179)*
+*Defined in [ws/index.ts:190](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/ws/index.ts#L190)*
-Allows subscribing to a specific event.
-*__example__*: const provider = new WsProvider('ws://127.0.0.1:9944'); const api = createApi(provider);
+*__name__*: subscribe
-api.state.storage(\[\[storage.balances.freeBalance,
+*__summary__*: Allows subscribing to a specific event.
-\]\], (_, values) => { console.log(values) }).then((subscriptionId) => { console.log('balance changes subscription id: ', subscriptionId) })
+*__example__*:
+
+```
+const provider = new WsProvider('ws://127.0.0.1:9944');
+const api = createApi(provider);
+
+api.state.storage([[storage.balances.freeBalance,
+```
**Parameters:**
@@ -349,9 +372,9 @@ ___
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
-*Defined in [ws/index.ts:188](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/ws/index.ts#L188)*
+*Defined in [ws/index.ts:199](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/ws/index.ts#L199)*
-Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe).
+*__summary__*: Allows unsubscribing to subscriptions made with [subscribe](_ws_index_.wsprovider.md#subscribe).
**Parameters:**
diff --git a/docs/api-provider/index.html b/docs/api-provider/index.html
index e55d4dfe1a..7c153859f1 100644
--- a/docs/api-provider/index.html
+++ b/docs/api-provider/index.html
@@ -426,7 +426,7 @@
diff --git a/docs/api-provider/interfaces/_types_d_.providerinterface.md b/docs/api-provider/interfaces/_types_d_.providerinterface.md
index 868edf0379..16d5141f60 100644
--- a/docs/api-provider/interfaces/_types_d_.providerinterface.md
+++ b/docs/api-provider/interfaces/_types_d_.providerinterface.md
@@ -16,7 +16,7 @@
▸ **isConnected**(): `boolean`
-*Defined in [types.d.ts:45](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/types.d.ts#L45)*
+*Defined in [types.d.ts:45](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/types.d.ts#L45)*
**Returns:** `boolean`
@@ -27,7 +27,7 @@ ___
▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_d_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_d_.md#providerinterface_emitcb)*): `void`
-*Defined in [types.d.ts:46](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/types.d.ts#L46)*
+*Defined in [types.d.ts:46](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/types.d.ts#L46)*
**Parameters:**
@@ -45,7 +45,7 @@ ___
▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`>
-*Defined in [types.d.ts:47](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/types.d.ts#L47)*
+*Defined in [types.d.ts:47](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/types.d.ts#L47)*
**Parameters:**
@@ -63,7 +63,7 @@ ___
▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *[ProviderInterface$Callback](../modules/_types_d_.md#providerinterface_callback)*): `Promise`<`number`>
-*Defined in [types.d.ts:48](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/types.d.ts#L48)*
+*Defined in [types.d.ts:48](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/types.d.ts#L48)*
**Parameters:**
@@ -83,7 +83,7 @@ ___
▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`>
-*Defined in [types.d.ts:49](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/types.d.ts#L49)*
+*Defined in [types.d.ts:49](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/types.d.ts#L49)*
**Parameters:**
diff --git a/docs/api-provider/modules/_coder_json_decoderesponse_.md b/docs/api-provider/modules/_coder_json_decoderesponse_.md
index c65bc84093..7c3777a4ff 100644
--- a/docs/api-provider/modules/_coder_json_decoderesponse_.md
+++ b/docs/api-provider/modules/_coder_json_decoderesponse_.md
@@ -8,7 +8,7 @@
▸ **decodeResponse**(self: *[RpcCoderState](_coder_json_types_d_.md#rpccoderstate)*, response: *[JsonRpcResponse](_types_d_.md#jsonrpcresponse)*): `any`
-*Defined in [coder/json/decodeResponse.ts:22](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/coder/json/decodeResponse.ts#L22)*
+*Defined in [coder/json/decodeResponse.ts:22](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/coder/json/decodeResponse.ts#L22)*
**Parameters:**
diff --git a/docs/api-provider/modules/_coder_json_encodejson_.md b/docs/api-provider/modules/_coder_json_encodejson_.md
index e6c6f15748..2b86df157b 100644
--- a/docs/api-provider/modules/_coder_json_encodejson_.md
+++ b/docs/api-provider/modules/_coder_json_encodejson_.md
@@ -8,7 +8,7 @@
▸ **encodeJson**(self: *[RpcCoderState](_coder_json_types_d_.md#rpccoderstate)*, method: *`string`*, params: *`Array`<`any`>*): `string`
-*Defined in [coder/json/encodeJson.ts:9](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/coder/json/encodeJson.ts#L9)*
+*Defined in [coder/json/encodeJson.ts:9](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/coder/json/encodeJson.ts#L9)*
**Parameters:**
diff --git a/docs/api-provider/modules/_coder_json_encodeobject_.md b/docs/api-provider/modules/_coder_json_encodeobject_.md
index 2532753e81..4962951e7c 100644
--- a/docs/api-provider/modules/_coder_json_encodeobject_.md
+++ b/docs/api-provider/modules/_coder_json_encodeobject_.md
@@ -8,7 +8,7 @@
▸ **encodeObject**(self: *[RpcCoderState](_coder_json_types_d_.md#rpccoderstate)*, method: *`string`*, params: *`Array`<`any`>*): [JsonRpcRequest](_types_d_.md#jsonrpcrequest)
-*Defined in [coder/json/encodeObject.ts:8](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/coder/json/encodeObject.ts#L8)*
+*Defined in [coder/json/encodeObject.ts:8](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/coder/json/encodeObject.ts#L8)*
**Parameters:**
diff --git a/docs/api-provider/modules/_coder_json_index_.md b/docs/api-provider/modules/_coder_json_index_.md
index 8e7e8dd40e..07398f4cfc 100644
--- a/docs/api-provider/modules/_coder_json_index_.md
+++ b/docs/api-provider/modules/_coder_json_index_.md
@@ -8,7 +8,7 @@
▸ **rpcCoder**(): [RpcCoder](_coder_json_types_d_.md#rpccoder)
-*Defined in [coder/json/index.ts:12](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/coder/json/index.ts#L12)*
+*Defined in [coder/json/index.ts:12](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/coder/json/index.ts#L12)*
**Returns:** [RpcCoder](_coder_json_types_d_.md#rpccoder)
diff --git a/docs/api-provider/modules/_coder_json_types_d_.md b/docs/api-provider/modules/_coder_json_types_d_.md
index b6c3fdf3e6..58632b765c 100644
--- a/docs/api-provider/modules/_coder_json_types_d_.md
+++ b/docs/api-provider/modules/_coder_json_types_d_.md
@@ -8,7 +8,7 @@
**Ƭ RpcCoder**: *`object`*
-*Defined in [coder/json/types.d.ts:7](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/coder/json/types.d.ts#L7)*
+*Defined in [coder/json/types.d.ts:7](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/coder/json/types.d.ts#L7)*
#### Type declaration
@@ -19,7 +19,7 @@ ___
**Ƭ RpcCoderState**: *`object`*
-*Defined in [coder/json/types.d.ts:14](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/coder/json/types.d.ts#L14)*
+*Defined in [coder/json/types.d.ts:14](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/coder/json/types.d.ts#L14)*
#### Type declaration
diff --git a/docs/api-provider/modules/_http_types_d_.md b/docs/api-provider/modules/_http_types_d_.md
index a70546ec79..1697d4d0d5 100644
--- a/docs/api-provider/modules/_http_types_d_.md
+++ b/docs/api-provider/modules/_http_types_d_.md
@@ -8,7 +8,7 @@
**Ƭ HttpState**: *`object`*
-*Defined in [http/types.d.ts:8](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/http/types.d.ts#L8)*
+*Defined in [http/types.d.ts:8](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/http/types.d.ts#L8)*
#### Type declaration
diff --git a/docs/api-provider/modules/_mock_index_.md b/docs/api-provider/modules/_mock_index_.md
index de0dbceaab..cd84a095d6 100644
--- a/docs/api-provider/modules/_mock_index_.md
+++ b/docs/api-provider/modules/_mock_index_.md
@@ -8,7 +8,7 @@
▸ **mockProvider**(): [ProviderInterface](../interfaces/_types_d_.providerinterface.md)
-*Defined in [mock/index.ts:18](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/mock/index.ts#L18)*
+*Defined in [mock/index.ts:18](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/mock/index.ts#L18)*
A moock provider mainly used for testing.
diff --git a/docs/api-provider/modules/_mock_mocks_.md b/docs/api-provider/modules/_mock_mocks_.md
index 5030ab2a6d..716399b9c6 100644
--- a/docs/api-provider/modules/_mock_mocks_.md
+++ b/docs/api-provider/modules/_mock_mocks_.md
@@ -8,7 +8,7 @@
▸ **mocks**(__namedParameters: *`object`*): `void`
-*Defined in [mock/mocks.ts:63](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/mock/mocks.ts#L63)*
+*Defined in [mock/mocks.ts:63](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/mock/mocks.ts#L63)*
**Parameters:**
diff --git a/docs/api-provider/modules/_mock_on_.md b/docs/api-provider/modules/_mock_on_.md
index 02a1c0905d..f73d412839 100644
--- a/docs/api-provider/modules/_mock_on_.md
+++ b/docs/api-provider/modules/_mock_on_.md
@@ -8,7 +8,7 @@
▸ **on**(self: *[MockState](_mock_types_d_.md#mockstate)*, type: *[ProviderInterface$Emitted](_types_d_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](_types_d_.md#providerinterface_emitcb)*): `void`
-*Defined in [mock/on.ts:8](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/mock/on.ts#L8)*
+*Defined in [mock/on.ts:8](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/mock/on.ts#L8)*
**Parameters:**
diff --git a/docs/api-provider/modules/_mock_send_.md b/docs/api-provider/modules/_mock_send_.md
index b6587e1834..7d72d36fa7 100644
--- a/docs/api-provider/modules/_mock_send_.md
+++ b/docs/api-provider/modules/_mock_send_.md
@@ -8,7 +8,7 @@
▸ **send**(__namedParameters: *`object`*, method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`>
-*Defined in [mock/send.ts:7](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/mock/send.ts#L7)*
+*Defined in [mock/send.ts:7](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/mock/send.ts#L7)*
**Parameters:**
diff --git a/docs/api-provider/modules/_mock_state_.md b/docs/api-provider/modules/_mock_state_.md
index 0dd8c1f2e9..98411b392d 100644
--- a/docs/api-provider/modules/_mock_state_.md
+++ b/docs/api-provider/modules/_mock_state_.md
@@ -8,7 +8,7 @@
▸ **state**(): [MockState](_mock_types_d_.md#mockstate)
-*Defined in [mock/state.ts:38](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/mock/state.ts#L38)*
+*Defined in [mock/state.ts:38](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/mock/state.ts#L38)*
**Returns:** [MockState](_mock_types_d_.md#mockstate)
diff --git a/docs/api-provider/modules/_mock_subscribe_.md b/docs/api-provider/modules/_mock_subscribe_.md
index 2d911664d1..804197f53b 100644
--- a/docs/api-provider/modules/_mock_subscribe_.md
+++ b/docs/api-provider/modules/_mock_subscribe_.md
@@ -8,7 +8,7 @@
▸ **subscribe**(self: *[MockState](_mock_types_d_.md#mockstate)*, type: *`string`*, method: *`string`*, params: *`Array`<`any`>*): `Promise`<`number`>
-*Defined in [mock/subscribe.ts:7](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/mock/subscribe.ts#L7)*
+*Defined in [mock/subscribe.ts:7](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/mock/subscribe.ts#L7)*
**Parameters:**
diff --git a/docs/api-provider/modules/_mock_types_d_.md b/docs/api-provider/modules/_mock_types_d_.md
index bbb3fe969e..ceedbd9c9e 100644
--- a/docs/api-provider/modules/_mock_types_d_.md
+++ b/docs/api-provider/modules/_mock_types_d_.md
@@ -8,7 +8,7 @@
**Ƭ MockState**: *`object`*
-*Defined in [mock/types.d.ts:27](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/mock/types.d.ts#L27)*
+*Defined in [mock/types.d.ts:27](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/mock/types.d.ts#L27)*
#### Type declaration
@@ -19,7 +19,7 @@ ___
**Ƭ MockState$Db**: *`object`*
-*Defined in [mock/types.d.ts:19](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/mock/types.d.ts#L19)*
+*Defined in [mock/types.d.ts:19](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/mock/types.d.ts#L19)*
#### Type declaration
@@ -32,7 +32,7 @@ ___
**Ƭ MockState$Requests**: *`object`*
-*Defined in [mock/types.d.ts:23](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/mock/types.d.ts#L23)*
+*Defined in [mock/types.d.ts:23](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/mock/types.d.ts#L23)*
#### Type declaration
@@ -56,7 +56,7 @@ ___
**Ƭ MockState$Subscription$Callback**: *`function`*
-*Defined in [mock/types.d.ts:8](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/mock/types.d.ts#L8)*
+*Defined in [mock/types.d.ts:8](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/mock/types.d.ts#L8)*
#### Type declaration
▸(error: * `Error` | `null`*, value: *`any`*): `void`
@@ -77,7 +77,7 @@ ___
**Ƭ MockState$Subscriptions**: *`object`*
-*Defined in [mock/types.d.ts:10](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/mock/types.d.ts#L10)*
+*Defined in [mock/types.d.ts:10](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/mock/types.d.ts#L10)*
#### Type declaration
diff --git a/docs/api-provider/modules/_mock_unsubscribe_.md b/docs/api-provider/modules/_mock_unsubscribe_.md
index 8a6d39faea..efc12c5c26 100644
--- a/docs/api-provider/modules/_mock_unsubscribe_.md
+++ b/docs/api-provider/modules/_mock_unsubscribe_.md
@@ -8,7 +8,7 @@
▸ **unsubscribe**(self: *[MockState](_mock_types_d_.md#mockstate)*, type: *`string`*, name: *`string`*, id: *`number`*): `Promise`<`boolean`>
-*Defined in [mock/unsubscribe.ts:7](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/mock/unsubscribe.ts#L7)*
+*Defined in [mock/unsubscribe.ts:7](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/mock/unsubscribe.ts#L7)*
**Parameters:**
diff --git a/docs/api-provider/modules/_types_d_.md b/docs/api-provider/modules/_types_d_.md
index 110a96bfae..9530a64193 100644
--- a/docs/api-provider/modules/_types_d_.md
+++ b/docs/api-provider/modules/_types_d_.md
@@ -8,7 +8,7 @@
**Ƭ JsonRpcObject**: *`object`*
-*Defined in [types.d.ts:5](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/types.d.ts#L5)*
+*Defined in [types.d.ts:5](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/types.d.ts#L5)*
#### Type declaration
@@ -20,7 +20,7 @@ ___
**Ƭ JsonRpcRequest**: * [JsonRpcObject](_types_d_.md#jsonrpcobject) & `object`
*
-*Defined in [types.d.ts:10](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/types.d.ts#L10)*
+*Defined in [types.d.ts:10](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/types.d.ts#L10)*
___
@@ -30,7 +30,7 @@ ___
**Ƭ JsonRpcResponse**: * [JsonRpcObject](_types_d_.md#jsonrpcobject) & [JsonRpcResponseBase](_types_d_.md#jsonrpcresponsebase)
*
-*Defined in [types.d.ts:36](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/types.d.ts#L36)*
+*Defined in [types.d.ts:36](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/types.d.ts#L36)*
___
@@ -40,7 +40,7 @@ ___
**Ƭ JsonRpcResponseBase**: * `JsonRpcResponse$Single` & `JsonRpcResponse$Subscription`
*
-*Defined in [types.d.ts:34](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/types.d.ts#L34)*
+*Defined in [types.d.ts:34](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/types.d.ts#L34)*
___
@@ -49,7 +49,7 @@ ___
**Ƭ JsonRpcResponseBase$Error**: *`object`*
-*Defined in [types.d.ts:15](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/types.d.ts#L15)*
+*Defined in [types.d.ts:15](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/types.d.ts#L15)*
#### Type declaration
@@ -60,7 +60,7 @@ ___
**Ƭ ProviderInterface$Callback**: *`function`*
-*Defined in [types.d.ts:38](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/types.d.ts#L38)*
+*Defined in [types.d.ts:38](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/types.d.ts#L38)*
#### Type declaration
▸(error: * `Error` | `null`*, result: *`any`*): `void`
@@ -81,7 +81,7 @@ ___
**Ƭ ProviderInterface$EmitCb**: *`function`*
-*Defined in [types.d.ts:42](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/types.d.ts#L42)*
+*Defined in [types.d.ts:42](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/types.d.ts#L42)*
#### Type declaration
▸(value?: *`any`*): `any`
@@ -102,7 +102,7 @@ ___
**Ƭ ProviderInterface$Emitted**: * "connected" | "disconnected"
*
-*Defined in [types.d.ts:40](https://github.com/polkadot-js/api/blob/522eae6/packages/api-provider/src/types.d.ts#L40)*
+*Defined in [types.d.ts:40](https://github.com/polkadot-js/api/blob/fd596a1/packages/api-provider/src/types.d.ts#L40)*
___
diff --git a/docs/api-rx/classes/_index_.rxapi.html b/docs/api-rx/classes/_index_.rxapi.html
index ec4eaf91c2..b7f4068f22 100644
--- a/docs/api-rx/classes/_index_.rxapi.html
+++ b/docs/api-rx/classes/_index_.rxapi.html
@@ -369,10 +369,16 @@
- An RxJs wrapper around the [[api]].
-example: import RxApi from '@polkadot/api'; import WsProvider from '@polkadot/api-provider/ws';
-const provider = new WsProvider('http://127.0.0.1:9944')); const rxapi = new RxApi(provider);
-Hierarchy
+ name: RxApi
+summary: The RxJS API is a wrapper around the API.
+description: It allows wrapping API components with observables using RxJS.
+example:
+import RxApi from '@polkadot/api';
+import WsProvider from '@polkadot/api-provider/ws';
+
+const provider = new WsProvider('http://127.0.0.1:9944');
+const rxapi = new RxApi(provider);
+
Hierarchy
RxApi
Implements