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

BatchStrategy.md

87 lines1.7 KB

1---
2id: BatchStrategy
3title: BatchStrategy
4---
5​
6# Class: BatchStrategy
7​
8Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:34](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/strategies.ts#L34)
9​
10Batch Strategy - emit every N chunks
11Useful for reducing UI update frequency
12​
13## Implements
14​
15- [`ChunkStrategy`](../interfaces/ChunkStrategy.md)
16​
17## Constructors
18​
19### Constructor
20​
21```ts
22new BatchStrategy(batchSize): BatchStrategy;
23```
24​
25Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:37](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/strategies.ts#L37)
26​
27#### Parameters
28​
29##### batchSize
30​
31`number` = `5`
32​
33#### Returns
34​
35`BatchStrategy`
36​
37## Methods
38​
39### reset()
40​
41```ts
42reset(): void;
43```
44​
45Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:48](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/strategies.ts#L48)
46​
47Optional: Reset strategy state (called when streaming starts)
48​
49#### Returns
50​
51`void`
52​
53#### Implementation of
54​
55[`ChunkStrategy`](../interfaces/ChunkStrategy.md).[`reset`](../interfaces/ChunkStrategy.md#reset)
56​
57***
58​
59### shouldEmit()
60​
61```ts
62shouldEmit(_chunk, _accumulated): boolean;
63```
64​
65Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:39](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/strategies.ts#L39)
66​
67Called for each text chunk received
68​
69#### Parameters
70​
71##### \_chunk
72​
73`string`
74​
75##### \_accumulated
76​
77`string`
78​
79#### Returns
80​
81`boolean`
82​
83true if an update should be emitted now
84​
85#### Implementation of
86​
87[`ChunkStrategy`](../interfaces/ChunkStrategy.md).[`shouldEmit`](../interfaces/ChunkStrategy.md#shouldemit)