Interface: FakeClock
Defined in: packages/testing/src/clock.ts:55
Properties
fn
readonly fn: () => number;
Defined in: packages/testing/src/clock.ts:61
Bound now, so it can be passed straight through: { clock: clock.fn }.
Returns
number
Methods
advance()
advance(ms): Promise<void>;
Defined in: packages/testing/src/clock.ts:71
Move time forward, running every timer that comes due — including timers
scheduled by those timers, which is how a retry-backoff chain unwinds.
Returns after awaiting the microtask queue, so engine flushes (which use
queueMicrotask) have settled by the time it resolves.
Parameters
| Parameter | Type |
|---|---|
ms | number |
Returns
Promise<void>
clearInterval()
clearInterval(id): void;
Defined in: packages/testing/src/clock.ts:85
Parameters
| Parameter | Type |
|---|---|
id | number |
Returns
void
clearTimeout()
clearTimeout(id): void;
Defined in: packages/testing/src/clock.ts:83
Parameters
| Parameter | Type |
|---|---|
id | number |
Returns
void
flush()
flush(): Promise<void>;
Defined in: packages/testing/src/clock.ts:75
Let queued microtasks run without moving the clock.
Returns
Promise<void>
install()
install(): () => void;
Defined in: packages/testing/src/clock.ts:91
Patch Date.now, the Date constructor and the global timer functions.
Returns the restore function; call it in afterEach.
Returns
() => void
iso()
iso(): string;
Defined in: packages/testing/src/clock.ts:59
The same value as an ISO-8601 UTC string — Rasd's wire/storage format (§12).
Returns
string
nextDue()
nextDue(): number | null;
Defined in: packages/testing/src/clock.ts:80
When the next timer is due, or null.
Returns
number | null
now()
now(): number;
Defined in: packages/testing/src/clock.ts:57
Epoch millis. The exact shape EngineOptions.clock wants.
Returns
number
pending()
pending(): number;
Defined in: packages/testing/src/clock.ts:78
Timers still registered.
Returns
number
runAll()
runAll(opts?): Promise<void>;
Defined in: packages/testing/src/clock.ts:73
Run pending timers in due order without a fixed budget of time.
Parameters
| Parameter | Type |
|---|---|
opts? | { maxTimers?: number; } |
opts.maxTimers? | number |
Returns
Promise<void>
setInterval()
setInterval(fn, ms): number;
Defined in: packages/testing/src/clock.ts:84
Parameters
| Parameter | Type |
|---|---|
fn | () => void |
ms | number |
Returns
number
setTime()
setTime(t): void;
Defined in: packages/testing/src/clock.ts:64
Jump to an absolute time. Timers already due are NOT run; use advance.
Parameters
| Parameter | Type |
|---|---|
t | string | number |
Returns
void
setTimeout()
setTimeout(fn, ms?): number;
Defined in: packages/testing/src/clock.ts:82
Parameters
| Parameter | Type |
|---|---|
fn | () => void |
ms? | number |
Returns
number