ManualScheduler
Defined in: src/testkit/ManualScheduler.ts:18
Scheduler implementation driven entirely by advance(ms) — the wall
clock is ignored. Swap this into ActorSystem.create(name, { scheduler })
in tests to get deterministic timer behaviour.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ManualScheduler():
ManualScheduler
Returns
Section titled “Returns”ManualScheduler
Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”pendingCount
Section titled “pendingCount”Get Signature
Section titled “Get Signature”get pendingCount():
number
Defined in: src/testkit/ManualScheduler.ts:79
Number of scheduled non-cancelled tasks.
Returns
Section titled “Returns”number
Methods
Section titled “Methods”advance()
Section titled “advance()”advance(
ms):void
Defined in: src/testkit/ManualScheduler.ts:88
Advance virtual time by ms. Any timers whose fireAt falls inside
the advanced range fire in deterministic order (earliest first, ties
broken by insertion order).
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
advanceToNext()
Section titled “advanceToNext()”advanceToNext():
void
Defined in: src/testkit/ManualScheduler.ts:111
Jump directly to the time of the next pending task (or no-op if none).
Returns
Section titled “Returns”void
now():
number
Defined in: src/testkit/ManualScheduler.ts:76
Current virtual time in ms (monotonic, advances only via advance).
Returns
Section titled “Returns”number
scheduleAtFixedRate()
Section titled “scheduleAtFixedRate()”scheduleAtFixedRate<
T>(initialDelayMs,intervalMs,target,message,sender?):Cancellable
Defined in: src/testkit/ManualScheduler.ts:54
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”Overrides
Section titled “Overrides”scheduleAtFixedRateFn()
Section titled “scheduleAtFixedRateFn()”scheduleAtFixedRateFn(
initialDelayMs,intervalMs,fn):Cancellable
Defined in: src/testkit/ManualScheduler.ts:42
Parameters
Section titled “Parameters”initialDelayMs
Section titled “initialDelayMs”number
intervalMs
Section titled “intervalMs”number
() => void
Returns
Section titled “Returns”Overrides
Section titled “Overrides”Scheduler.scheduleAtFixedRateFn
scheduleOnce()
Section titled “scheduleOnce()”scheduleOnce<
T>(delayMs,target,message,sender?):Cancellable
Defined in: src/testkit/ManualScheduler.ts:30
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”Overrides
Section titled “Overrides”scheduleOnceFn()
Section titled “scheduleOnceFn()”scheduleOnceFn(
delayMs,fn):Cancellable
Defined in: src/testkit/ManualScheduler.ts:26
Run a user-supplied function once after a delay.
Parameters
Section titled “Parameters”delayMs
Section titled “delayMs”number
() => void