TanStack

SandboxFileCustomEvent

Defined in: packages/ai/src/types.ts:1511

Custom event for extensibility.

@ag-ui/core provides: name, value, subagentRunId?

Extends

Properties

metadata?

ts
optional metadata?: Record<string, any>;

Defined in: packages/ai/src/types.ts:1416

Extra information attached to this event.

Inherited from

CustomEvent.metadata


name

ts
name: "sandbox.file";

Defined in: packages/ai/src/types.ts:1512

What this custom event is. Required: without it a consumer cannot route the value.

Overrides

ts
CustomEvent.name

type

ts
type: "CUSTOM";

Defined in: packages/ai/src/types.ts:1415

Inherited from

CustomEvent.type


value

ts
value: object;

Defined in: packages/ai/src/types.ts:1513

The payload. Any JSON value, and required.

path

ts
path: string;

timestamp

ts
timestamp: number;

type

ts
type: "create" | "change" | "delete";

Overrides

ts
CustomEvent.value