ToolStreamUpdateEvent
Defined in: src/hooks/events.ts:705
Event triggered for each streaming progress event from a tool during execution.
Wraps a ToolStreamEvent with invocation context, keeping the tool authoring
interface unchanged — tools construct ToolStreamEvent without knowledge of agents
or hooks, and the agent layer wraps them at the boundary.
Consistent with ModelStreamUpdateEvent which wraps model streaming events the same way.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ToolStreamUpdateEvent(data): ToolStreamUpdateEvent;Defined in: src/hooks/events.ts:711
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
data | { agent: LocalAgent; event: ToolStreamEvent; invocationState: InvocationState; } & HookableEventData |
Returns
Section titled “Returns”ToolStreamUpdateEvent
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: "toolStreamUpdateEvent";Defined in: src/hooks/events.ts:706
readonly agent: LocalAgent;Defined in: src/hooks/events.ts:707
readonly event: ToolStreamEvent;Defined in: src/hooks/events.ts:708
invocationState
Section titled “invocationState”readonly invocationState: InvocationState;Defined in: src/hooks/events.ts:709
Methods
Section titled “Methods”toJSON()
Section titled “toJSON()”toJSON(): Pick<ToolStreamUpdateEvent, "type" | "event">;Defined in: src/hooks/events.ts:724
Serializes for wire transport, excluding the agent reference and invocationState. Called automatically by JSON.stringify().
Returns
Section titled “Returns”Pick<ToolStreamUpdateEvent, "type" | "event">