Skip to content

Commit 33a91e5

Browse files
github-actions[bot]github-actions[bot]
authored
docs: regenerate API documentation (#847)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 9d6cbfe commit 33a91e5

269 files changed

Lines changed: 18871 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/reference/classes/BatchStrategy.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
id: BatchStrategy
3+
title: BatchStrategy
4+
---
5+
6+
# Class: BatchStrategy
7+
8+
Defined 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+
10+
Batch Strategy - emit every N chunks
11+
Useful for reducing UI update frequency
12+
13+
## Implements
14+
15+
- [`ChunkStrategy`](../interfaces/ChunkStrategy.md)
16+
17+
## Constructors
18+
19+
### Constructor
20+
21+
```ts
22+
new BatchStrategy(batchSize): BatchStrategy;
23+
```
24+
25+
Defined 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
42+
reset(): void;
43+
```
44+
45+
Defined 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+
47+
Optional: 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
62+
shouldEmit(_chunk, _accumulated): boolean;
63+
```
64+
65+
Defined 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+
67+
Called 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+
83+
true if an update should be emitted now
84+
85+
#### Implementation of
86+
87+
[`ChunkStrategy`](../interfaces/ChunkStrategy.md).[`shouldEmit`](../interfaces/ChunkStrategy.md#shouldemit)

‎docs/reference/classes/CompositeStrategy.md‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
id: CompositeStrategy
3+
title: CompositeStrategy
4+
---
5+
6+
# Class: CompositeStrategy
7+
8+
Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:68](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/strategies.ts#L68)
9+
10+
Composite Strategy - combine multiple strategies (OR logic)
11+
Emits if ANY strategy says to emit
12+
13+
## Implements
14+
15+
- [`ChunkStrategy`](../interfaces/ChunkStrategy.md)
16+
17+
## Constructors
18+
19+
### Constructor
20+
21+
```ts
22+
new CompositeStrategy(strategies): CompositeStrategy;
23+
```
24+
25+
Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:69](https://github.com/TanStack/ai/blob/main/packages/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
42+
reset(): void;
43+
```
44+
45+
Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:75](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/strategies.ts#L75)
46+
47+
Optional: 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
62+
shouldEmit(chunk, accumulated): boolean;
63+
```
64+
65+
Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:71](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/strategies.ts#L71)
66+
67+
Called for each text chunk received
68+
69+
#### Parameters
70+
71+
##### chunk
72+
73+
`string`
74+
75+
The new chunk of text (delta)
76+
77+
##### accumulated
78+
79+
`string`
80+
81+
All text accumulated so far
82+
83+
#### Returns
84+
85+
`boolean`
86+
87+
true if an update should be emitted now
88+
89+
#### Implementation of
90+
91+
[`ChunkStrategy`](../interfaces/ChunkStrategy.md).[`shouldEmit`](../interfaces/ChunkStrategy.md#shouldemit)

‎docs/reference/classes/ConsoleLogger.md‎

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
---
2+
id: ConsoleLogger
3+
title: ConsoleLogger
4+
---
5+
6+
# Class: ConsoleLogger
7+
8+
Defined in: [packages/ai/src/logger/console-logger.ts:101](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L101)
9+
10+
Default `Logger` implementation that routes each level to the matching
11+
`console` method:
12+
13+
- `debug` → `console.debug`
14+
- `info` → `console.info`
15+
- `warn` → `console.warn`
16+
- `error` → `console.error`
17+
18+
When a `meta` object is supplied it is rendered with the strategy that
19+
actually surfaces it on the current runtime (see MetaStrategy):
20+
depth-unlimited `console.dir` on Node, circular-safe JSON on Cloudflare
21+
Workers, and an extra console argument everywhere else.
22+
23+
This is the logger used when `debug` is enabled on any activity and no
24+
custom `logger` is supplied via `debug: { logger }`.
25+
26+
## Implements
27+
28+
- [`Logger`](../interfaces/Logger.md)
29+
30+
## Constructors
31+
32+
### Constructor
33+
34+
```ts
35+
new ConsoleLogger(): ConsoleLogger;
36+
```
37+
38+
#### Returns
39+
40+
`ConsoleLogger`
41+
42+
## Methods
43+
44+
### debug()
45+
46+
```ts
47+
debug(message, meta?): void;
48+
```
49+
50+
Defined in: [packages/ai/src/logger/console-logger.ts:103](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L103)
51+
52+
Log a debug-level message; forwards to `console.debug`.
53+
54+
#### Parameters
55+
56+
##### message
57+
58+
`string`
59+
60+
##### meta?
61+
62+
`Record`\<`string`, `unknown`\>
63+
64+
#### Returns
65+
66+
`void`
67+
68+
#### Implementation of
69+
70+
[`Logger`](../interfaces/Logger.md).[`debug`](../interfaces/Logger.md#debug)
71+
72+
***
73+
74+
### error()
75+
76+
```ts
77+
error(message, meta?): void;
78+
```
79+
80+
Defined in: [packages/ai/src/logger/console-logger.ts:118](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L118)
81+
82+
Log an error-level message; forwards to `console.error`.
83+
84+
#### Parameters
85+
86+
##### message
87+
88+
`string`
89+
90+
##### meta?
91+
92+
`Record`\<`string`, `unknown`\>
93+
94+
#### Returns
95+
96+
`void`
97+
98+
#### Implementation of
99+
100+
[`Logger`](../interfaces/Logger.md).[`error`](../interfaces/Logger.md#error)
101+
102+
***
103+
104+
### info()
105+
106+
```ts
107+
info(message, meta?): void;
108+
```
109+
110+
Defined in: [packages/ai/src/logger/console-logger.ts:108](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L108)
111+
112+
Log an info-level message; forwards to `console.info`.
113+
114+
#### Parameters
115+
116+
##### message
117+
118+
`string`
119+
120+
##### meta?
121+
122+
`Record`\<`string`, `unknown`\>
123+
124+
#### Returns
125+
126+
`void`
127+
128+
#### Implementation of
129+
130+
[`Logger`](../interfaces/Logger.md).[`info`](../interfaces/Logger.md#info)
131+
132+
***
133+
134+
### warn()
135+
136+
```ts
137+
warn(message, meta?): void;
138+
```
139+
140+
Defined in: [packages/ai/src/logger/console-logger.ts:113](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L113)
141+
142+
Log a warning-level message; forwards to `console.warn`.
143+
144+
#### Parameters
145+
146+
##### message
147+
148+
`string`
149+
150+
##### meta?
151+
152+
`Record`\<`string`, `unknown`\>
153+
154+
#### Returns
155+
156+
`void`
157+
158+
#### Implementation of
159+
160+
[`Logger`](../interfaces/Logger.md).[`warn`](../interfaces/Logger.md#warn)

‎docs/reference/classes/ImmediateStrategy.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
id: ImmediateStrategy
3+
title: ImmediateStrategy
4+
---
5+
6+
# Class: ImmediateStrategy
7+
8+
Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:12](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/strategies.ts#L12)
9+
10+
Immediate Strategy - emit on every chunk (default behavior)
11+
12+
## Implements
13+
14+
- [`ChunkStrategy`](../interfaces/ChunkStrategy.md)
15+
16+
## Constructors
17+
18+
### Constructor
19+
20+
```ts
21+
new ImmediateStrategy(): ImmediateStrategy;
22+
```
23+
24+
#### Returns
25+
26+
`ImmediateStrategy`
27+
28+
## Methods
29+
30+
### shouldEmit()
31+
32+
```ts
33+
shouldEmit(_chunk, _accumulated): boolean;
34+
```
35+
36+
Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:13](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/strategies.ts#L13)
37+
38+
Called for each text chunk received
39+
40+
#### Parameters
41+
42+
##### \_chunk
43+
44+
`string`
45+
46+
##### \_accumulated
47+
48+
`string`
49+
50+
#### Returns
51+
52+
`boolean`
53+
54+
true if an update should be emitted now
55+
56+
#### Implementation of
57+
58+
[`ChunkStrategy`](../interfaces/ChunkStrategy.md).[`shouldEmit`](../interfaces/ChunkStrategy.md#shouldemit)

0 commit comments

Comments
 (0)