AIDK API Reference / aidk-client / ChannelDefinition

Interface: ChannelDefinition<TIncoming, TOutgoing>

Defined in: packages/client/src/channel.ts:36

Channel definition - the contract for a channel

Type Parameters

Type Parameter	Default type
TIncoming extends Record<string, unknown>	Record<string, unknown>
TOutgoing extends Record<string, unknown>	Record<string, unknown>

Properties

Property	Type	Description	Defined in
_incoming?	TIncoming	Incoming event types (for type inference)	packages/client/src/channel.ts:45
_outgoing?	TOutgoing	Outgoing event types (for type inference)	packages/client/src/channel.ts:47
name	string	Channel name	packages/client/src/channel.ts:41

Methods

connect()

connect(client: EngineClient): Channel<TIncoming, TOutgoing>;

Defined in: packages/client/src/channel.ts:43

Create a connected channel instance

Parameters

Parameter	Type
client	EngineClient

Returns

Channel<TIncoming, TOutgoing>