AIDK API Reference / aidk-kernel / Channel

Class: Channel

Defined in: packages/kernel/src/channel.ts:88

Core Channel primitive. Works standalone in any Node environment. Uses EventEmitter internally for pub/sub.

Constructors

Constructor

new Channel(name: string): Channel;

Defined in: packages/kernel/src/channel.ts:101

Parameters

Parameter	Type
name	string

Returns

Channel

Properties

Property	Modifier	Type	Defined in
name	readonly	string	packages/kernel/src/channel.ts:101

Methods

destroy()

destroy(): void;

Defined in: packages/kernel/src/channel.ts:230

Cleanup: remove all subscribers and pending requests.

Returns

void

---

getSubscriberCount()

getSubscriberCount(): number;

Defined in: packages/kernel/src/channel.ts:223

Get the number of active subscribers.

Returns

number

---

publish()

publish(event: ChannelEvent): void;

Defined in: packages/kernel/src/channel.ts:106

Publish an event to the channel.

Parameters

Parameter	Type
event	ChannelEvent

Returns

void

---

subscribe()

subscribe(handler: (event: ChannelEvent) => void): () => void;

Defined in: packages/kernel/src/channel.ts:167

Subscribe to events on this channel.

Parameters

Parameter	Type
handler	(event: ChannelEvent) => void

Returns

Unsubscribe function

(): void;

Returns

void

---

waitForResponse()

waitForResponse(requestId: string, timeoutMs: number): Promise<ChannelEvent>;

Defined in: packages/kernel/src/channel.ts:183

Wait for a response to a specific request. Used by tools/components for bidirectional communication.

Parameters

Parameter	Type	Default value	Description
requestId	string	undefined	The request ID to wait for
timeoutMs	number	30000	Timeout in milliseconds (default: 30000)

Returns

Promise<ChannelEvent>

Promise that resolves when response is received