FakeClock
Defined in: testing/fake-clock.ts:10
A manual clock for tests (ADR 0006). Time only moves when you call advance(), and
timers fire in deadline order.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FakeClock(
start?):FakeClock
Defined in: testing/fake-clock.ts:15
Parameters
Section titled “Parameters”start?
Section titled “start?”number = FAKE_EPOCH
Returns
Section titled “Returns”FakeClock
Accessors
Section titled “Accessors”pendingTimers
Section titled “pendingTimers”Get Signature
Section titled “Get Signature”get pendingTimers():
number
Defined in: testing/fake-clock.ts:34
Number of timers waiting to fire.
Returns
Section titled “Returns”number
Methods
Section titled “Methods”advance()
Section titled “advance()”advance(
ms,settle?):Promise<void>
Defined in: testing/fake-clock.ts:43
Moves time forward by ms, firing every timer that falls due on the way, in
deadline order. settle runs after each firing (the test table passes its
queue's idle()), so timers scheduled by fired timers are honoured too.
Parameters
Section titled “Parameters”number
settle?
Section titled “settle?”() => Promise<void>
Returns
Section titled “Returns”Promise<void>
clearTimer()
Section titled “clearTimer()”clearTimer(
handle):void
Defined in: testing/fake-clock.ts:29
Parameters
Section titled “Parameters”handle
Section titled “handle”Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”now():
number
Defined in: testing/fake-clock.ts:19
Current time, epoch milliseconds.
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”setTimer()
Section titled “setTimer()”setTimer(
atMs,fn):TimerHandle
Defined in: testing/fake-clock.ts:23
Calls fn at (or soon after) the absolute time atMs.
Parameters
Section titled “Parameters”number
() => void
