Scheduler
Defined in: src/Scheduler.ts:27
Time-based scheduler — a thin wrapper over setTimeout / setInterval,
accurate enough for typical use and good enough for tests. Inject a
ManualScheduler from the TestKit when you want fully deterministic
time advancement.
Extended by
Section titled “Extended by”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Scheduler():
Scheduler
Returns
Section titled “Returns”Scheduler
Methods
Section titled “Methods”scheduleAtFixedRate()
Section titled “scheduleAtFixedRate()”scheduleAtFixedRate<
T>(initialDelayMs,intervalMs,target,message,sender?):Cancellable
Defined in: src/Scheduler.ts:60
Deliver a message repeatedly at a fixed interval, after an initial delay.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”initialDelayMs
Section titled “initialDelayMs”number
intervalMs
Section titled “intervalMs”number
target
Section titled “target”ActorRef<T>
message
Section titled “message”T
sender?
Section titled “sender?”ActorRef<unknown> | null
Returns
Section titled “Returns”scheduleAtFixedRateFn()
Section titled “scheduleAtFixedRateFn()”scheduleAtFixedRateFn(
initialDelayMs,intervalMs,fn):Cancellable
Defined in: src/Scheduler.ts:88
Parameters
Section titled “Parameters”initialDelayMs
Section titled “initialDelayMs”number
intervalMs
Section titled “intervalMs”number
() => void
Returns
Section titled “Returns”scheduleOnce()
Section titled “scheduleOnce()”scheduleOnce<
T>(delayMs,target,message,sender?):Cancellable
Defined in: src/Scheduler.ts:31
Deliver a message once after a delay.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”delayMs
Section titled “delayMs”number
target
Section titled “target”ActorRef<T>
message
Section titled “message”T
sender?
Section titled “sender?”ActorRef<unknown> | null
Returns
Section titled “Returns”scheduleOnceFn()
Section titled “scheduleOnceFn()”scheduleOnceFn(
delayMs,fn):Cancellable
Defined in: src/Scheduler.ts:47
Run a user-supplied function once after a delay.
Parameters
Section titled “Parameters”delayMs
Section titled “delayMs”number
() => void