Skip to content

Documentation / @agentick/react / useEvents

Function: useEvents() ​

useEvents(options?): UseEventsResult

Defined in: react/src/hooks/use-events.ts:31

Subscribe to stream events.

Returns a batched array of events. Events that fire synchronously (e.g. parallel tool results) are accumulated in a ref and flushed via a single microtask — one render per synchronous burst, zero events lost.

Parameters ​

options? ​

UseEventsOptions = {}

Returns ​

UseEventsResult

Example ​

tsx
function ToolTracker() {
  const { events } = useEvents({ filter: ['tool_result'] });

  useEffect(() => {
    for (const event of events) {
      console.log('Tool result:', event);
    }
  }, [events]);
}

Released under the ISC License.