Interface Clock

Where a session gets its time: timers for delayed <send>s and deferred work for external events. Pass one as SessionOptions.clock.

interface Clock {
    clearTimeout(handle: unknown): void;
    defer(fn: () => void): void;
    now(): number;
    setTimeout(fn: () => void, ms: number): unknown;
}

Implemented by

VirtualClock

Index

Methods

clearTimeout defer now setTimeout

Methods

clearTimeout

clearTimeout(handle: unknown): void
Cancel a timer from setTimeout. Unknown or already-fired handles are ignored.
Parameters
- handle: unknown
Returns void

defer

defer(fn: () => void): void
Run fn soon, after the current task (a microtask on the real clock).
Parameters
- fn: () => void
Returns void

now

now(): number
The current time in ms (real or virtual).

Returns number

setTimeout

setTimeout(fn: () => void, ms: number): unknown
Run fn after ms milliseconds of this clock's time; returns a handle for clearTimeout.
Parameters
- fn: () => void
- ms: number
Returns unknown