Skip to content

Graphorin API reference v0.7.0


Graphorin API reference / @graphorin/tools / / StreamingAggregator

Interface: StreamingAggregator

Defined in: packages/tools/src/streaming/channel.ts:87

Aggregated chunks the executor reads after the tool returns. The chunks array is the source of truth for the buffer-becomes-output discipline; the executor passes it to toResultEnvelope({ chunks }).

Stable

Properties

PropertyModifierTypeDescriptionDefined in
bufferTruncatedreadonlybooleanW-117: true when the aggregation buffer hit maxBufferBytes and later chunks were dropped from the ASSEMBLED body (sink delivery continued). Consumers building an output / spill artifact from chunks must treat the body as incomplete.packages/tools/src/streaming/channel.ts:98
chunkCountreadonlynumber-packages/tools/src/streaming/channel.ts:89
chunksreadonlyreadonly ContentChunk[]-packages/tools/src/streaming/channel.ts:88
progressEventCountreadonlynumber-packages/tools/src/streaming/channel.ts:90
totalBytesreadonlynumber-packages/tools/src/streaming/channel.ts:91