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

ErrorStreamChunk.md

90 lines1.5 KB

1---
2id: ErrorStreamChunk
3title: ErrorStreamChunk
4---
5​
6# Interface: ErrorStreamChunk
7​
8Defined in: [types.ts:684](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L684)
9​
10## Extends
11​
12- [`BaseStreamChunk`](BaseStreamChunk.md)
13​
14## Properties
15​
16### error
17​
18```ts
19error: object;
20```
21​
22Defined in: [types.ts:686](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L686)
23​
24#### code?
25​
26```ts
27optional code: string;
28```
29​
30#### message
31​
32```ts
33message: string;
34```
35​
36***
37​
38### id
39​
40```ts
41id: string;
42```
43​
44Defined in: [types.ts:643](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L643)
45​
46#### Inherited from
47​
48[`BaseStreamChunk`](BaseStreamChunk.md).[`id`](BaseStreamChunk.md#id)
49​
50***
51​
52### model
53​
54```ts
55model: string;
56```
57​
58Defined in: [types.ts:644](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L644)
59​
60#### Inherited from
61​
62[`BaseStreamChunk`](BaseStreamChunk.md).[`model`](BaseStreamChunk.md#model)
63​
64***
65​
66### timestamp
67​
68```ts
69timestamp: number;
70```
71​
72Defined in: [types.ts:645](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L645)
73​
74#### Inherited from
75​
76[`BaseStreamChunk`](BaseStreamChunk.md).[`timestamp`](BaseStreamChunk.md#timestamp)
77​
78***
79​
80### type
81​
82```ts
83type: "error";
84```
85​
86Defined in: [types.ts:685](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L685)
87​
88#### Overrides
89​
90[`BaseStreamChunk`](BaseStreamChunk.md).[`type`](BaseStreamChunk.md#type)