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

CompositeStrategy.md

91 lines1.8 KB

1---
2id: CompositeStrategy
3title: CompositeStrategy
4---
5​
6# Class: CompositeStrategy
7​
8Defined in: [activities/chat/stream/strategies.ts:68](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L68)
9​
10Composite Strategy - combine multiple strategies (OR logic)
11Emits if ANY strategy says to emit
12​
13## Implements
14​
15- [`ChunkStrategy`](../interfaces/ChunkStrategy.md)
16​
17## Constructors
18​
19### Constructor
20​
21```ts
22new CompositeStrategy(strategies): CompositeStrategy;
23```
24​
25Defined in: [activities/chat/stream/strategies.ts:69](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L69)
26​
27#### Parameters
28​
29##### strategies
30​
31[`ChunkStrategy`](../interfaces/ChunkStrategy.md)[]
32​
33#### Returns
34​
35`CompositeStrategy`
36​
37## Methods
38​
39### reset()
40​
41```ts
42reset(): void;
43```
44​
45Defined in: [activities/chat/stream/strategies.ts:75](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L75)
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: [activities/chat/stream/strategies.ts:71](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L71)
66​
67Called for each text chunk received
68​
69#### Parameters
70​
71##### chunk
72​
73`string`
74​
75The new chunk of text (delta)
76​
77##### accumulated
78​
79`string`
80​
81All text accumulated so far
82​
83#### Returns
84​
85`boolean`
86​
87true if an update should be emitted now
88​
89#### Implementation of
90​
91[`ChunkStrategy`](../interfaces/ChunkStrategy.md).[`shouldEmit`](../interfaces/ChunkStrategy.md#shouldemit)