Open History to see the last commit
1---
2id: SandboxFileHookEvent
3title: SandboxFileHookEvent
4---
5
6# Interface: SandboxFileHookEvent
7
8Defined in: [packages/ai/src/activities/chat/middleware/types.ts:28](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L28)
9
10The file event a sandbox hook receives: the serializable [SandboxFileEvent](SandboxFileEvent.md)
11 plus lazy, git-backed content accessors. Accessors compute on call, so a hook
12 that only reads `path`/`type` pays nothing. Never present on the serialized
13 `sandbox.file` CUSTOM chunk.
14
15## Extends
16
17- [`SandboxFileEvent`](SandboxFileEvent.md)
18
19## Properties
20
21### after()
22
23```ts
24after: () => Promise<string>;
25```
26
27Defined in: [packages/ai/src/activities/chat/middleware/types.ts:32](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L32)
28
29Current content (`''` when the event is a delete).
30
31#### Returns
32
33`Promise`\<`string`\>
34
35***
36
37### before()
38
39```ts
40before: () => Promise<string>;
41```
42
43Defined in: [packages/ai/src/activities/chat/middleware/types.ts:30](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L30)
44
45Content at the session baseline (`''` for a new file or non-git workspace).
46
47#### Returns
48
49`Promise`\<`string`\>
50
51***
52
53### diff()
54
55```ts
56diff: () => Promise<string>;
57```
58
59Defined in: [packages/ai/src/activities/chat/middleware/types.ts:34](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L34)
60
61Unified patch vs the session baseline (synthesized add-patch when non-git).
62
63#### Returns
64
65`Promise`\<`string`\>
66
67***
68
69### path
70
71```ts
72path: string;
73```
74
75Defined in: [packages/ai/src/activities/chat/middleware/types.ts:20](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L20)
76
77Absolute path inside the sandbox (under the workspace root).
78
79#### Inherited from
80
81[`SandboxFileEvent`](SandboxFileEvent.md).[`path`](SandboxFileEvent.md#path)
82
83***
84
85### timestamp
86
87```ts
88timestamp: number;
89```
90
91Defined in: [packages/ai/src/activities/chat/middleware/types.ts:21](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L21)
92
93#### Inherited from
94
95[`SandboxFileEvent`](SandboxFileEvent.md).[`timestamp`](SandboxFileEvent.md#timestamp)
96
97***
98
99### type
100
101```ts
102type: "create" | "change" | "delete";
103```
104
105Defined in: [packages/ai/src/activities/chat/middleware/types.ts:18](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L18)
106
107#### Inherited from
108
109[`SandboxFileEvent`](SandboxFileEvent.md).[`type`](SandboxFileEvent.md#type)