AIDK API Reference / aidk-client / ChannelClient

Class: ChannelClient

Defined in: packages/client/src/core/channel-client.ts:56

Constructors

Constructor

new ChannelClient(config: ChannelClientConfig): ChannelClient;

Defined in: packages/client/src/core/channel-client.ts:67

Parameters

Parameter	Type
config	ChannelClientConfig

Returns

ChannelClient

Methods

disconnect()

disconnect(): void;

Defined in: packages/client/src/core/channel-client.ts:169

Disconnect (clears all handlers)

Returns

void

---

dispose()

dispose(): void;

Defined in: packages/client/src/core/channel-client.ts:177

Dispose of client and cleanup

Returns

void

---

getInfo()

getInfo(): TransportInfo;

Defined in: packages/client/src/core/channel-client.ts:146

Get connection info

Returns

TransportInfo

---

getState()

getState(): TransportState;

Defined in: packages/client/src/core/channel-client.ts:139

Get connection state

Returns

TransportState

---

isConnected()

isConnected(): boolean;

Defined in: packages/client/src/core/channel-client.ts:153

Check if connected

Returns

boolean

---

publish()

publish<T>(
   channel: string, 
   type: string, 
   payload?: unknown): Promise<T>;

Defined in: packages/client/src/core/channel-client.ts:127

Publish an event to a channel. Uses publish override if provided, otherwise sends via transport.

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
channel	string
type	string
payload?	unknown

Returns

Promise<T>

---

reconnect()

reconnect(): void;

Defined in: packages/client/src/core/channel-client.ts:160

Force reconnection

Returns

void

---

subscribe()

subscribe(channelFilter: string | string[], handler: EventHandler): () => void;

Defined in: packages/client/src/core/channel-client.ts:84

Subscribe to channel events.

Parameters

Parameter	Type
channelFilter	string | string[]
handler	EventHandler

Returns

Unsubscribe function

(): void;

Returns

void