Class WebsocketClient

Hierarchy

WebsocketClient

Implements

RpcStreamingClient

Index

Constructors

constructor

Methods

Constructors

constructor

new WebsocketClient(baseUrl?: undefined | string, onError?: undefined | function): WebsocketClient

- Defined in home/travis/build/iov-one/iov-core/packages/iov-tendermint-rpc/types/rpcclients/websocketclient.d.ts:9
Parameters
- Optional baseUrl: undefined | string
- Optional onError: undefined | function
Returns WebsocketClient

Methods

connected

connected(): Promise<void>

- Defined in home/travis/build/iov-one/iov-core/packages/iov-tendermint-rpc/types/rpcclients/websocketclient.d.ts:17
Resolves as soon as websocket is connected. execute() queues requests automatically, so this should be required for testing purposes only.

Returns Promise<void>

disconnect

disconnect(): void

- Defined in home/travis/build/iov-one/iov-core/packages/iov-tendermint-rpc/types/rpcclients/websocketclient.d.ts:18
Returns void

execute

execute(request: JsonRpcRequest): Promise<JsonRpcSuccessResponse>

- Defined in home/travis/build/iov-one/iov-core/packages/iov-tendermint-rpc/types/rpcclients/websocketclient.d.ts:11
Parameters
- request: JsonRpcRequest
Returns Promise<JsonRpcSuccessResponse>

listen

listen(request: JsonRpcRequest): Stream<SubscriptionEvent>

- Defined in home/travis/build/iov-one/iov-core/packages/iov-tendermint-rpc/types/rpcclients/websocketclient.d.ts:12
Parameters
- request: JsonRpcRequest
Returns Stream<SubscriptionEvent>

Protected responseForRequestId

responseForRequestId(id: JsonRpcId): Promise<JsonRpcResponse>

- Defined in home/travis/build/iov-one/iov-core/packages/iov-tendermint-rpc/types/rpcclients/websocketclient.d.ts:19
Parameters
- id: JsonRpcId
Returns Promise<JsonRpcResponse>

Generated using TypeDoc