Class WebsocketClient

Hierarchy

WebsocketClient

Implements

RpcStreamingClient

Index

Constructors

Methods

connected disconnect execute listen responseForRequestId

Constructors

constructor

new WebsocketClient(baseUrl: string, onError?: ((err: any) => void)): WebsocketClient
Parameters
- baseUrl: string
- onError: ((err: any) => void) = defaultErrorHandler
  - - (err: any): void
    - Parameters
      
      err: any
      
      Returns void
Returns WebsocketClient
- Defined in rpcclients/websocketclient.ts:145

Methods

connected

connected(): Promise<void>
Resolves as soon as websocket is connected. execute() queues requests automatically, so this should be required for testing purposes only.

Returns Promise<void>
- Defined in rpcclients/websocketclient.ts:202

disconnect

disconnect(): void
Returns void
Implementation of RpcStreamingClient.disconnect
- Defined in rpcclients/websocketclient.ts:206

execute

execute(request: JsonRpcRequest): Promise<JsonRpcSuccessResponse>
Parameters
- request: JsonRpcRequest
Returns Promise<JsonRpcSuccessResponse>
Implementation of RpcStreamingClient.execute
- Defined in rpcclients/websocketclient.ts:168

listen

listen(request: JsonRpcRequest): Stream<SubscriptionEvent>
Parameters
- request: JsonRpcRequest
Returns Stream<SubscriptionEvent>
Implementation of RpcStreamingClient.listen
- Defined in rpcclients/websocketclient.ts:179

`Protected` responseForRequestId

responseForRequestId(id: JsonRpcId): Promise<JsonRpcResponse>
Parameters
- id: JsonRpcId
Returns Promise<JsonRpcResponse>
- Defined in rpcclients/websocketclient.ts:210

Generated using TypeDoc