TanStack

ChatSandboxHooks

Interface: ChatSandboxHooks<TContext>

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

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?

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

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

Parameters

ctx

ChatMiddlewareContext<TContext>

e

SandboxFileHookEvent

Returns

void | Promise<void>


onFileChange?

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

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

Parameters

ctx

ChatMiddlewareContext<TContext>

e

SandboxFileHookEvent

Returns

void | Promise<void>


onFileCreate?

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

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

Parameters

ctx

ChatMiddlewareContext<TContext>

e

SandboxFileHookEvent

Returns

void | Promise<void>


onFileDelete?

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

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

Parameters

ctx

ChatMiddlewareContext<TContext>

e

SandboxFileHookEvent

Returns

void | Promise<void>