Function

useTimelineEvent

Subscribes to a typed TimelineEngine event with a React-safe latest handler. The hook keeps the event subscription stable while updating the callback ref every render, avoiding stale closures without resubscribing for handler-only changes.

Signature

useTimelineEvent(eventName: EventName, handler: TimelineEventHandler<EventName>, options: TimelineEventOptions = {}): void

Type parameters

Name	Constraint	Default	Description
`EventName`	`typeOperator`	None	No type parameter summary yet.

Parameters

Name	Type	Description
eventName	EventName	TimelineEngine event name to subscribe to.
handler	TimelineEventHandler<EventName>	Callback invoked with the typed event payload.
options	TimelineEventOptions	Optional subscription controls.

Returns

void