BeforeToolsEvent
Defined in: src/hooks/events.ts:547
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:559
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
data | { agent: LocalAgent; message: Message; } |
data.agent | LocalAgent |
data.message | Message |
Returns
Section titled “Returns”BeforeToolsEvent
Overrides
Section titled “Overrides”Properties
Section titled “Properties”readonly type: "beforeToolsEvent";Defined in: src/hooks/events.ts:548
readonly agent: LocalAgent;Defined in: src/hooks/events.ts:549
message
Section titled “message”readonly message: Message;Defined in: src/hooks/events.ts:550
cancel
Section titled “cancel”cancel: string | boolean = false;Defined in: src/hooks/events.ts:557
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:569
Serializes for wire transport, excluding the agent reference and mutable cancel flag. Called automatically by JSON.stringify().
Returns
Section titled “Returns”Pick<BeforeToolsEvent, "type" | "message">