Documentation / @agentick/react / UseEventsOptions

Interface: UseEventsOptions

Defined in: react/src/types.ts:195

Options for useEvents hook.

Properties

enabled?

optional enabled: boolean

Defined in: react/src/types.ts:213

Whether the hook is enabled. If false, no event subscription is created.

Default

true

---

filter?

optional filter: ("tool_result" | "reasoning" | "error" | "content_start" | "content_delta" | "content_end" | "content" | "reasoning_start" | "reasoning_delta" | "reasoning_end" | "message_start" | "message_end" | "message" | "tool_call_start" | "tool_call_delta" | "tool_call_end" | "tool_call" | "usage" | "custom_block_start" | "custom_block_delta" | "custom_block_end" | "custom_block" | "execution_start" | "execution_end" | "execution" | "tick_start" | "tick_end" | "tick" | "tool_result_start" | "tool_confirmation_required" | "tool_confirmation_result" | "compiled" | "model_request" | "provider_request" | "model_response" | "entry_committed" | "engine_error" | "context_update" | "fork_start" | "fork_end" | "spawn_start" | "spawn_end" | "result")[]

Defined in: react/src/types.ts:206

Optional event type filter. If provided, only events of these types are returned.

---

sessionId?

optional sessionId: string

Defined in: react/src/types.ts:200

Optional session ID to filter events for. If not provided, receives all events from all sessions.