0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-18 19:34:58 +00:00
ai/docs/reference/classes/BatchStrategy.md
github-actions[bot] 5701bf5184
docs: regenerate API documentation (#1141)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-08-18 19:53:35 +02:00

1.7 KiB

id title
BatchStrategy BatchStrategy

Class: BatchStrategy

Defined in: packages/ai/src/activities/chat/stream/strategies.ts:34

Batch Strategy - emit every N chunks Useful for reducing UI update frequency

Implements

Constructors

Constructor

new BatchStrategy(batchSize?): BatchStrategy;

Defined in: packages/ai/src/activities/chat/stream/strategies.ts:37

Parameters

batchSize?

number = 5

Returns

BatchStrategy

Methods

reset()

reset(): void;

Defined in: packages/ai/src/activities/chat/stream/strategies.ts:48

Optional: Reset strategy state (called when streaming starts)

Returns

void

Implementation of

ChunkStrategy.reset


shouldEmit()

shouldEmit(_chunk, _accumulated): boolean;

Defined in: packages/ai/src/activities/chat/stream/strategies.ts:39

Called for each text chunk received

Parameters

_chunk

string

_accumulated

string

Returns

boolean

true if an update should be emitted now

Implementation of

ChunkStrategy.shouldEmit