AIDK API Reference / aidk-kernel / ChannelEvent
Interface: ChannelEvent ​
Defined in: packages/kernel/src/channel.ts:42
Normalized channel event structure. Loosely structured but normalized for consistency.
Properties ​
| Property | Type | Description | Defined in |
|---|---|---|---|
channel | string | Channel name (e.g., 'ui:progress', 'ui:user-input', 'tool:status') | packages/kernel/src/channel.ts:56 |
id? | string | Request/response correlation ID (for bidirectional communication) | packages/kernel/src/channel.ts:51 |
metadata? | { [key: string]: unknown; executionId?: string; source?: string; sourceConnectionId?: string; tick?: number; timestamp?: number; } | Optional metadata | packages/kernel/src/channel.ts:66 |
metadata.executionId? | string | - | packages/kernel/src/channel.ts:69 |
metadata.source? | string | - | packages/kernel/src/channel.ts:68 |
metadata.sourceConnectionId? | string | - | packages/kernel/src/channel.ts:71 |
metadata.tick? | number | - | packages/kernel/src/channel.ts:70 |
metadata.timestamp? | number | - | packages/kernel/src/channel.ts:67 |
payload | any | Flexible event payload | packages/kernel/src/channel.ts:61 |
target? | ChannelTarget | Optional routing target. If not specified, event is broadcast to all channel subscribers. Used by transports for targeted delivery. | packages/kernel/src/channel.ts:80 |
type | string | Event type (normalized patterns: 'request', 'response', 'progress', 'status', 'error') | packages/kernel/src/channel.ts:46 |