ToolInterrupt

Defined in: shared/src/tool/tool.interrupt.ts:8

Thrown by a tool to suspend the run and hand control back to the caller for a decision (e.g. human approval). data is shown to the caller; state is the tool’s private checkpoint, returned verbatim as the resumption’s state when the caller answers. Across an HTTP boundary the type is lost, so transports serialise it into an envelope and reconstruct it on the far side.

Extends

• Error

Constructors

Constructor

new ToolInterrupt(
   message,
   data?,
   state?): ToolInterrupt;

Defined in: shared/src/tool/tool.interrupt.ts:12

Parameters

Parameter	Type
message	string
data?	unknown
state?	unknown

Returns

ToolInterrupt

Overrides

Error.constructor

Properties

data?

readonly optional data?: unknown;

Defined in: shared/src/tool/tool.interrupt.ts:9

---

state?

readonly optional state?: unknown;

Defined in: shared/src/tool/tool.interrupt.ts:10