Function: createTimerActor()

August 8, 2026 ยท View on GitHub

@plures/praxis


@plures/praxis / index / createTimerActor

Function: createTimerActor()

createTimerActor<TContext>(id, intervalMs, createEvent): Actor<TContext>

Defined in: packages/praxis-core/src/actors.ts:188

Helper to create a simple actor that dispatches events on a timer

Type Parameters

TContext

TContext = unknown

Parameters

id

string

Unique identifier for the actor

intervalMs

number

Timer interval in milliseconds

createEvent

() => PraxisEvent

Factory function that creates the event to dispatch on each tick

Returns

Actor<TContext>

An Actor that starts a timer on onStart and clears it on onStop