BeforeToolsEvent
Defined in: src/hooks/events.ts:777
Event triggered before executing tools. Fired when the model returns tool use blocks that need to be executed. Hook callbacks can set cancel to prevent all tools from executing.
Extends
Section titled “Extends”Implements
Section titled “Implements”Interruptible
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BeforeToolsEvent(data): BeforeToolsEvent;Defined in: src/hooks/events.ts:790
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
data | { agent: LocalAgent; message: Message; invocationState: InvocationState; } & HookableEventData |
Returns
Section titled “Returns”BeforeToolsEvent
Overrides
Section titled “Overrides”Properties
Section titled “Properties”invocationContext?
Section titled “invocationContext?”readonly invocationContext?: InvocationContext;Defined in: src/hooks/events.ts:100
The request this event belongs to (undefined outside one); pass it to InvokeOptions.invocationContext to join it.
Inherited from
Section titled “Inherited from”HookableEvent.invocationContext
readonly type: "beforeToolsEvent";Defined in: src/hooks/events.ts:778
readonly agent: LocalAgent;Defined in: src/hooks/events.ts:779
message
Section titled “message”readonly message: Message;Defined in: src/hooks/events.ts:780
invocationState
Section titled “invocationState”readonly invocationState: InvocationState;Defined in: src/hooks/events.ts:781
cancel
Section titled “cancel”cancel: string | boolean = false;Defined in: src/hooks/events.ts:788
Set by hook callbacks to cancel all tool calls.
When set to true, a default cancel message is used.
When set to a string, that string is used as the tool result error message.
Methods
Section titled “Methods”interrupt()
Section titled “interrupt()”interrupt<T>(params): T;Defined in: src/hooks/events.ts:805
Raises an interrupt for human-in-the-loop workflows. If a response is available (from a previous resume), returns it immediately. Otherwise, throws an InterruptError to halt agent execution.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T | JSONValue |
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
params | InterruptParams | Interrupt parameters including name and optional reason |
Returns
Section titled “Returns”T
The user’s response when resuming from an interrupt
Implementation of
Section titled “Implementation of”Interruptible.interrupt
toJSON()
Section titled “toJSON()”toJSON(): Pick<BeforeToolsEvent, "type" | "message">;Defined in: src/hooks/events.ts:813
Serializes for wire transport, excluding the agent reference, invocationState, and mutable cancel flag. Called automatically by JSON.stringify().
Returns
Section titled “Returns”Pick<BeforeToolsEvent, "type" | "message">