Type parameters
+EventTypes : string | symbol
+Hierarchy
+ EventEmitter
↳ ApiRx
+Implements
+ +Constructors
+ +constructor
+⊕ new ApiRx(wsProvider?: WsProvider): ApiRx
Defined in rx/index.ts:59
+example:
+import Api from '@polkadot/api/rx';
+
+new Api().isReady.subscribe((api) => {
+ api.rpc.newHead().subscribe((header) => {
+ console.log(`new block #${header.blockNumber.toNumber()}`);
+ });
+});
+Parameters:
+| Param | +Type | +Description | +
|---|---|---|
Optional wsProvider |
+WsProvider |
+An optional WebSocket provider from rpc-provider/ws. If not specified, it will default to connecting to the localhost with the default port | +
Returns: ApiRx
++
Properties
+ +isReady
+● isReady: Observable<ApiRx>
Implementation of RxApiInterface.isReady
+Defined in rx/index.ts:39
++ +
<Static> prefixed
+● prefixed: string | boolean
+
Inherited from EventEmitter.prefixed
+Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:6
++
Accessors
+ +genesisHash
+getgenesisHash(): Hash
Defined in rx/index.ts:94
+description: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.
+Returns: Hash
+ +
isConnected
+getisConnected(): Observable<boolean>
Defined in rx/index.ts:87
+description: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.
+Returns: Observable<boolean>
+ +
rpc
+getrpc(): RpcRx
Defined in rx/index.ts:113
+description: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions.
+example:
+api.rpc.chain
+ .newHead()
+ .subscribe((header) => {
+ console.log('new header', header);
+ });
+Returns: RpcRx
+ +
runtimeMetadata
+getruntimeMetadata(): RuntimeMetadata
Defined in rx/index.ts:120
+description: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
+Returns: RuntimeMetadata
+ +
runtimeVersion
+getruntimeVersion(): RuntimeVersion
Defined in rx/index.ts:129
+description: Contains the version information for the current runtime.
+Returns: RuntimeVersion
+ +
st
+getst(): QueryableStorage
+Defined in rx/index.ts:148
+description: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
+example:
+api.st.balances
+ .freeBalance(<accountId>)
+ .subscribe((balance) => {
+ console.log('new balance', balance);
+ });
+Returns: QueryableStorage
++ +
tx
+gettx(): SubmittableExtrinsics
+Defined in rx/index.ts:169
+description: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.
+example:
+api.tx.balances
+ .transfer(<recipientId>, <balance>)
+ .sign(<keyPair>, <accountNonce>, <blockHash (optional)>)
+ .send()
+ .subscribe((status) => {
+ console.log('tx status', status);
+ });
+Returns: SubmittableExtrinsics
++
Methods
+ +addListener
+▸ addListener(event: EventTypes, fn: ListenerFn, context?: any): this
Inherited from EventEmitter.addListener
+Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:33
+Parameters:
+| Param | +Type | +
|---|---|
| event | +EventTypes |
+
| fn | +ListenerFn |
+
Optional context |
+any |
+
Returns: this
+ +
emit
+▸ emit(event: EventTypes, ...args: Array<any>): boolean
Inherited from EventEmitter.emit
+Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:27
+Calls each of the listeners registered for a given event.
+Parameters:
+| Param | +Type | +
|---|---|
| event | +EventTypes |
+
Rest args |
+Array<any> |
+
Returns: boolean
+ +
eventNames
+▸ eventNames(): Array<EventTypes>
Inherited from EventEmitter.eventNames
+Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:12
+Return an array listing the events for which the emitter has registered listeners.
+Returns: Array<EventTypes>
+ +
listenerCount
+▸ listenerCount(event: EventTypes): number
Inherited from EventEmitter.listenerCount
+Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:22
+Return the number of listeners listening to a given event.
+Parameters:
+| Param | +Type | +
|---|---|
| event | +EventTypes |
+
Returns: number
+ +
listeners
+▸ listeners(event: EventTypes): Array<ListenerFn>
Inherited from EventEmitter.listeners
+Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:17
+Return the listeners registered for a given event.
+Parameters:
+| Param | +Type | +
|---|---|
| event | +EventTypes |
+
Returns: Array<ListenerFn>
+ +
off
+▸ off(event: EventTypes, fn?: ListenerFn, context?: any, once?: undefined | false | true): this
Inherited from EventEmitter.off
+Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:44
+Parameters:
+| Param | +Type | +
|---|---|
| event | +EventTypes |
+
Optional fn |
+ListenerFn | +
Optional context |
+any |
+
Optional once |
+undefined | false | true |
+
Returns: this
+ +
on
+▸ on(event: EventTypes, fn: ListenerFn, context?: any): this
Inherited from EventEmitter.on
+Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:32
+Add a listener for a given event.
+Parameters:
+| Param | +Type | +
|---|---|
| event | +EventTypes |
+
| fn | +ListenerFn |
+
Optional context |
+any |
+
Returns: this
+ +
once
+▸ once(event: EventTypes, fn: ListenerFn, context?: any): this
Inherited from EventEmitter.once
+Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:38
+Add a one-time listener for a given event.
+Parameters:
+| Param | +Type | +
|---|---|
| event | +EventTypes |
+
| fn | +ListenerFn |
+
Optional context |
+any |
+
Returns: this
+ +
removeAllListeners
+▸ removeAllListeners(event?: EventTypes): this
Inherited from EventEmitter.removeAllListeners
+Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:49
+Remove all listeners, or those of the specified event.
+Parameters:
+| Param | +Type | +
|---|---|
Optional event |
+EventTypes | +
Returns: this
+ +
removeListener
+▸ removeListener(event: EventTypes, fn?: ListenerFn, context?: any, once?: undefined | false | true): this
Inherited from EventEmitter.removeListener
+Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:43
+Remove the listeners of a given event.
+Parameters:
+| Param | +Type | +
|---|---|
| event | +EventTypes |
+
Optional fn |
+ListenerFn | +
Optional context |
+any |
+
Optional once |
+undefined | false | true |
+
Returns: this
+ +
<Static> create
+▸ create(wsProvider?: WsProvider): Observable<ApiRx>
Defined in rx/index.ts:57
+description: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.
+example:
+import Api from '@polkadot/api/rx';
+
+Api.create().subscribe((api) => {
+ api.st.timestamp.now((timestamp) => {
+ console.log(`lastest block timestamp ${timestamp}`);
+ });
+});
+Parameters:
+| Param | +Type | +Description | +
|---|---|---|
Optional wsProvider |
+WsProvider |
+Optional WebSocket provider that is passed to the class contructor | +
Returns: Observable<ApiRx>
+ + +
