Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

StreamProcessorOptions.md

82 lines1.7 KB

1---
2id: StreamProcessorOptions
3title: StreamProcessorOptions
4---
5​
6# Interface: StreamProcessorOptions
7​
8Defined in: [packages/ai/src/activities/chat/stream/processor.ts:125](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L125)
9​
10Options for StreamProcessor
11​
12## Properties
13​
14### chunkStrategy?
15​
16```ts
17optional chunkStrategy: ChunkStrategy;
18```
19​
20Defined in: [packages/ai/src/activities/chat/stream/processor.ts:126](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L126)
21​
22***
23​
24### events?
25​
26```ts
27optional events: StreamProcessorEvents;
28```
29​
30Defined in: [packages/ai/src/activities/chat/stream/processor.ts:128](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L128)
31​
32Event-driven handlers
33​
34***
35​
36### initialMessages?
37​
38```ts
39optional initialMessages: UIMessage<unknown>[];
40```
41​
42Defined in: [packages/ai/src/activities/chat/stream/processor.ts:135](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L135)
43​
44Initial messages to populate the processor
45​
46***
47​
48### jsonParser?
49​
50```ts
51optional jsonParser: object;
52```
53​
54Defined in: [packages/ai/src/activities/chat/stream/processor.ts:129](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L129)
55​
56#### parse()
57​
58```ts
59parse: (jsonString) => any;
60```
61​
62##### Parameters
63​
64###### jsonString
65​
66`string`
67​
68##### Returns
69​
70`any`
71​
72***
73​
74### recording?
75​
76```ts
77optional recording: boolean;
78```
79​
80Defined in: [packages/ai/src/activities/chat/stream/processor.ts:133](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L133)
81​
82Enable recording for replay testing