Files
api/docs/rpc-rx/classes/_index_.rpcrx.md
T
2018-10-11 07:38:36 +00:00

7.0 KiB

name: RpcRx

summary: The RxJS API is a wrapper around the API.

description: It allows wrapping API components with observables using RxJS.

example:

import RpcRx from '@polkadot/rpc-rx';
import WsProvider from '@polkadot/rpc-provider/ws';

const provider = new WsProvider('http://127.0.0.1:9944');
const api = new RpcRx(provider);

Type parameters

EventTypes : string | symbol

Hierarchy

EventEmitter

↳ RpcRx

Implements

  • object

Constructors

constructor

⊕ new RpcRx(provider?: ProviderInterface): RpcRx

Defined in index.ts:47

Parameters:

Param Type Default value Description
Default value provider ProviderInterface new Ws(defaults.WS_URL) An API provider using HTTP or WebSocket

Returns: RpcRx


Properties

author

● author: RpcRxInterface$Section

Defined in index.ts:44


chain

● chain: RpcRxInterface$Section

Defined in index.ts:45


state

● state: RpcRxInterface$Section

Defined in index.ts:46


system

● system: RpcRxInterface$Section

Defined in index.ts:47


<Static> prefixed

● prefixed: * string | boolean *

Inherited from EventEmitter.prefixed

Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:6


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>


isConnected

▸ isConnected(): BehaviorSubject<boolean>

Defined in index.ts:67

Returns: BehaviorSubject<boolean>


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