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

PunctuationStrategy.md

61 lines1.2 KB

1---
2id: PunctuationStrategy
3title: PunctuationStrategy
4---
5​
6# Class: PunctuationStrategy
7​
8Defined in: [packages/typescript/ai/src/activities/chat/stream/strategies.ts:22](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L22)
9​
10Punctuation Strategy - emit when chunk contains punctuation
11Useful for natural text flow in UI
12​
13## Implements
14​
15- [`ChunkStrategy`](../interfaces/ChunkStrategy.md)
16​
17## Constructors
18​
19### Constructor
20​
21```ts
22new PunctuationStrategy(): PunctuationStrategy;
23```
24​
25#### Returns
26​
27`PunctuationStrategy`
28​
29## Methods
30​
31### shouldEmit()
32​
33```ts
34shouldEmit(chunk, _accumulated): boolean;
35```
36​
37Defined in: [packages/typescript/ai/src/activities/chat/stream/strategies.ts:25](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/stream/strategies.ts#L25)
38​
39Called for each text chunk received
40​
41#### Parameters
42​
43##### chunk
44​
45`string`
46​
47The new chunk of text (delta)
48​
49##### \_accumulated
50​
51`string`
52​
53#### Returns
54​
55`boolean`
56​
57true if an update should be emitted now
58​
59#### Implementation of
60​
61[`ChunkStrategy`](../interfaces/ChunkStrategy.md).[`shouldEmit`](../interfaces/ChunkStrategy.md#shouldemit)