Class WsClientTransport

Interface for client-side transports

Hierarchy (view full)

EventEmitter<WsClientEvents>
- WsClientTransport

Implements

IClientTransport

Index

Constructors

Accessors

state isConnected

Methods

on off once emit removeAllListeners listenerCount fromAddress send close connect reconnect

Constructors

constructor

new WsClientTransport(url, options?): WsClientTransport
Create a new WebSocket client transport
Parameters
- url: string
  WebSocket URL (ws:// or wss://)
- options: WsClientOptions = {}
  Connection options
Returns WsClientTransport
Overrides EventEmitter.constructor
- Defined in transport/ws/client.ts:86

Accessors

state

get state(): TransportState
Current transport state

Returns TransportState
Implementation of IClientTransport.state
- Defined in transport/ws/client.ts:110

isConnected

get isConnected(): boolean
Whether the transport is currently connected

Returns boolean
Implementation of IClientTransport.isConnected
- Defined in transport/ws/client.ts:114

Methods

on

on<K>(event, listener): this
Register an event listener
Type Parameters
- K extends keyof TransportEvents
Parameters
- event: K
- listener: EventListener<WsClientEvents[K]>
Returns this
Implementation of IClientTransport.on
Inherited from EventEmitter.on
- Defined in transport/event-emitter.ts:17

off

off<K>(event, listener): this
Remove an event listener
Type Parameters
- K extends keyof TransportEvents
Parameters
- event: K
- listener: EventListener<WsClientEvents[K]>
Returns this
Implementation of IClientTransport.off
Inherited from EventEmitter.off
- Defined in transport/event-emitter.ts:28

once

once<K>(event, listener): this
Register a one-time event listener
Type Parameters
- K extends keyof TransportEvents
Parameters
- event: K
- listener: EventListener<WsClientEvents[K]>
Returns this
Implementation of IClientTransport.once
Inherited from EventEmitter.once
- Defined in transport/event-emitter.ts:37

`Protected` emit

emit<K>(event, ...args): boolean
Emit an event
Type Parameters
- K extends keyof TransportEvents
Parameters
- event: K
- Rest ...args: WsClientEvents[K]
Returns boolean
Inherited from EventEmitter.emit
- Defined in transport/event-emitter.ts:48

removeAllListeners

removeAllListeners<K>(event?): this
Remove all listeners for an event, or all events
Type Parameters
- K extends keyof TransportEvents
Parameters
- Optional event: K
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in transport/event-emitter.ts:76

listenerCount

listenerCount<K>(event): number
Get the number of listeners for an event
Type Parameters
- K extends keyof TransportEvents
Parameters
- event: K
Returns number
Inherited from EventEmitter.listenerCount
- Defined in transport/event-emitter.ts:90

`Static` fromAddress

fromAddress(host, port, options?): WsClientTransport
Create from host and port
Parameters
- host: string
- port: number
- options: WsClientOptions & {
  secure?: boolean;
  path?: string;
  } = {}
Returns WsClientTransport
- Defined in transport/ws/client.ts:95

send

send(message): Promise<void>
Send a message through the transport
Parameters
- message: JsonRpcMessage | JsonRpcResponse
Returns Promise<void>
Promise that resolves when the message is sent (not when response is received)
Implementation of IClientTransport.send
- Defined in transport/ws/client.ts:118

close

close(reason?): Promise<void>
Close the transport connection
Parameters
- Optional reason: string
  Optional reason for closing
Returns Promise<void>
Implementation of IClientTransport.close
- Defined in transport/ws/client.ts:145

connect

connect(): Promise<void>
Connect to the server

Returns Promise<void>
Implementation of IClientTransport.connect
- Defined in transport/ws/client.ts:166

reconnect

reconnect(): Promise<void>
Reconnect to the server (if disconnected)

Returns Promise<void>
Implementation of IClientTransport.reconnect
- Defined in transport/ws/client.ts:177