Graphorin API reference v0.1.0
Graphorin API reference / @graphorin/tools / / StreamingChannelOptions
Interface: StreamingChannelOptions
Defined in: packages/tools/src/streaming/channel.ts:30
Configuration for createStreamingChannel.
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
eventQueueDepth? | readonly | number | Max in-flight events kept in the per-channel buffer. Default 256. | packages/tools/src/streaming/channel.ts:35 |
now? | readonly | () => number | Wall clock for tests. Defaults to Date.now. | packages/tools/src/streaming/channel.ts:52 |
sink? | readonly | (event) => void | Optional sink invoked for every streaming event. The agent runtime injects a sink that re-emits into agent.stream(...). Tests pass a fixture sink to assert event ordering. | packages/tools/src/streaming/channel.ts:50 |
stepNumber | readonly | number | - | packages/tools/src/streaming/channel.ts:33 |
streamingHint? | readonly | boolean | Optional streaming-hint flag. When false the channel turns report / content into no-ops; the executor still reads the empty assembled buffer at the end so the buffer-becomes-output discipline degrades gracefully. Default true | packages/tools/src/streaming/channel.ts:44 |
toolCallId | readonly | string | - | packages/tools/src/streaming/channel.ts:32 |
toolName | readonly | string | - | packages/tools/src/streaming/channel.ts:31 |