BeforeToolsEvent
Defined in: src/hooks/events.ts:674
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”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BeforeToolsEvent(data): BeforeToolsEvent;Defined in: src/hooks/events.ts:687
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
data | { agent: LocalAgent; message: Message; invocationState: InvocationState; } |
data.agent | LocalAgent |
data.message | Message |
data.invocationState | InvocationState |
Returns
Section titled “Returns”BeforeToolsEvent
Overrides
Section titled “Overrides”Properties
Section titled “Properties”readonly type: "beforeToolsEvent";Defined in: src/hooks/events.ts:675
readonly agent: LocalAgent;Defined in: src/hooks/events.ts:676
message
Section titled “message”readonly message: Message;Defined in: src/hooks/events.ts:677
invocationState
Section titled “invocationState”readonly invocationState: InvocationState;Defined in: src/hooks/events.ts:678
cancel
Section titled “cancel”cancel: string | boolean = false;Defined in: src/hooks/events.ts:685
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”toJSON()
Section titled “toJSON()”toJSON(): Pick<BeforeToolsEvent, "type" | "message">;Defined in: src/hooks/events.ts:698
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">