Skip to content

SandboxStartingEvent

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

withSandbox sends this before it creates or resumes the sandbox.

Extends

Properties

metadata?

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

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

Extra information attached to this event.

Inherited from

CustomEvent.metadata


name

ts
name: "sandbox.starting";

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

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:1813

Inherited from

CustomEvent.type


value

ts
value: object;

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

The payload. Any JSON value, and required.

provider

ts
provider: string;

Overrides

ts
CustomEvent.value