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

StreamProcessorOptions.md

94 lines2.0 KB

1---
2id: StreamProcessorOptions
3title: StreamProcessorOptions
4---
5​
6# Interface: StreamProcessorOptions
7​
8Defined in: [activities/chat/stream/processor.ts:136](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L136)
9​
10Options for StreamProcessor
11​
12## Properties
13​
14### chunkStrategy?
15​
16```ts
17optional chunkStrategy: ChunkStrategy;
18```
19​
20Defined in: [activities/chat/stream/processor.ts:137](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L137)
21​
22***
23​
24### events?
25​
26```ts
27optional events: StreamProcessorEvents;
28```
29​
30Defined in: [activities/chat/stream/processor.ts:139](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L139)
31​
32New event-driven handlers
33​
34***
35​
36### handlers?
37​
38```ts
39optional handlers: StreamProcessorHandlers;
40```
41​
42Defined in: [activities/chat/stream/processor.ts:141](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L141)
43​
44Legacy callback handlers (for backward compatibility)
45​
46***
47​
48### initialMessages?
49​
50```ts
51optional initialMessages: UIMessage[];
52```
53​
54Defined in: [activities/chat/stream/processor.ts:148](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L148)
55​
56Initial messages to populate the processor
57​
58***
59​
60### jsonParser?
61​
62```ts
63optional jsonParser: object;
64```
65​
66Defined in: [activities/chat/stream/processor.ts:142](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L142)
67​
68#### parse()
69​
70```ts
71parse: (jsonString) => any;
72```
73​
74##### Parameters
75​
76###### jsonString
77​
78`string`
79​
80##### Returns
81​
82`any`
83​
84***
85​
86### recording?
87​
88```ts
89optional recording: boolean;
90```
91​
92Defined in: [activities/chat/stream/processor.ts:146](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/processor.ts#L146)
93​
94Enable recording for replay testing