pdum_aiui

Appearance

Interface: Envelope ​

Defined in: packages/aiui-claude-channel/src/frame.ts:135

The routing/lifecycle metadata carried in every frame's header.

Properties ​

chunk? ​

optional chunk?: ChunkDescriptor

Defined in: packages/aiui-claude-channel/src/frame.ts:152

On an intent-v1 data frame: how to interpret the payload (see ChunkDescriptor). Absent on other formats and legacy frames.

fin? ​

optional fin?: boolean

Defined in: packages/aiui-claude-channel/src/frame.ts:147

On a data frame: true when this is the thread's final frame.

format? ​

optional format?: string

Defined in: packages/aiui-claude-channel/src/frame.ts:141

On a hello: the stream format the connection will speak.

kind ​

kind: EnvelopeKind

Defined in: packages/aiui-claude-channel/src/frame.ts:139

What this frame is.

meta? ​

optional meta?: HelloMeta

Defined in: packages/aiui-claude-channel/src/frame.ts:143

On a hello: optional client context (tab identity, source location).

threadId? ​

optional threadId?: string

Defined in: packages/aiui-claude-channel/src/frame.ts:145

On a data frame: the client-generated thread id it belongs to.

v ​

v: number

Defined in: packages/aiui-claude-channel/src/frame.ts:137

Protocol version (see PROTOCOL_VERSION).