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

ChatSandboxHooks.md

113 lines2.3 KB

Interface: ChatSandboxHooks<TContext>

Defined in: packages/ai/src/activities/chat/middleware/types.ts:41

Sandbox file-event hooks a chat middleware can declare. Fire server-side for every file create/change/delete observed in the sandbox during the run.

Type Parameters

TContext

TContext = unknown

Properties

onFile()?

optional onFile: (ctx, e) => void | Promise<void>;

Defined in: packages/ai/src/activities/chat/middleware/types.ts:42

Parameters

ctx

ChatMiddlewareContext<TContext>

e

SandboxFileHookEvent

Returns

void | Promise<void>


onFileChange()?

optional onFileChange: (ctx, e) => void | Promise<void>;

Defined in: packages/ai/src/activities/chat/middleware/types.ts:50

Parameters

ctx

ChatMiddlewareContext<TContext>

e

SandboxFileHookEvent

Returns

void | Promise<void>


onFileCreate()?

optional onFileCreate: (ctx, e) => void | Promise<void>;

Defined in: packages/ai/src/activities/chat/middleware/types.ts:46

Parameters

ctx

ChatMiddlewareContext<TContext>

e

SandboxFileHookEvent

Returns

void | Promise<void>


onFileDelete()?

optional onFileDelete: (ctx, e) => void | Promise<void>;

Defined in: packages/ai/src/activities/chat/middleware/types.ts:54

Parameters

ctx

ChatMiddlewareContext<TContext>

e

SandboxFileHookEvent

Returns

void | Promise<void>