0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-16 19:38:41 +00:00
ai/docs/reference/interfaces/StreamProcessorOptions.md
github-actions[bot] 1999af2267
docs: regenerate API documentation (#1260)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-08-28 11:42:19 +02:00

1.7 KiB

id title
StreamProcessorOptions StreamProcessorOptions

Interface: StreamProcessorOptions

Defined in: packages/ai/src/activities/chat/stream/processor.ts:136

Options for StreamProcessor

Properties

chunkStrategy?

optional chunkStrategy?: ChunkStrategy;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:137


events?

optional events?: StreamProcessorEvents;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:139

Event-driven handlers


initialMessages?

optional initialMessages?: UIMessage<unknown>[];

Defined in: packages/ai/src/activities/chat/stream/processor.ts:146

Initial messages to populate the processor


jsonParser?

optional jsonParser?: object;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:140

parse

parse: (jsonString) => any;
Parameters
jsonString

string

Returns

any


recording?

optional recording?: boolean;

Defined in: packages/ai/src/activities/chat/stream/processor.ts:144

Enable recording for replay testing