Class WebsocketClient

Hierarchy

WebsocketClient

Implements

RpcStreamingClient

Index

Constructors

constructor

Methods

Constructors

constructor

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

- Defined in rpcclients/websocketclient.ts:144
Parameters
- Default value baseUrl: string = "ws://localhost:46657"
- Default value onError: function = defaultErrorHandler
  - - (err: any): void
    - Parameters
      - err: any
      Returns void
Returns WebsocketClient

Methods

connected

connected(): Promise<void>

- Defined in rpcclients/websocketclient.ts:204
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 rpcclients/websocketclient.ts:208
Returns void

execute

execute(request: JsonRpcRequest): Promise<JsonRpcSuccessResponse>

- Defined in rpcclients/websocketclient.ts:170
Parameters
- request: JsonRpcRequest
Returns Promise<JsonRpcSuccessResponse>

listen

listen(request: JsonRpcRequest): Stream<SubscriptionEvent>

- Defined in rpcclients/websocketclient.ts:181
Parameters
- request: JsonRpcRequest
Returns Stream<SubscriptionEvent>

Protected responseForRequestId

responseForRequestId(id: JsonRpcId): Promise<JsonRpcResponse>

- Defined in rpcclients/websocketclient.ts:212
Parameters
- id: JsonRpcId
Returns Promise<JsonRpcResponse>

Generated using TypeDoc