Interface Clock

Abstraction over time and timers.

Components that need the current time or need to schedule work take a Clock rather than calling Date.now / setTimeout directly. In production pass systemClock; in tests pass a ManualClock to advance time deterministically.

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

Implemented by

ManualClock

Index

Methods

clearTimeout now setTimeout

Methods

clearTimeout

clearTimeout(handle: unknown): void
Cancels a timer previously created with setTimeout.
Parameters
- handle: unknown
  The handle returned by setTimeout.
Returns void
- Defined in packages/core/src/Clock.ts:25

now

now(): number
Returns the current time.

Returns number
Milliseconds since an implementation-defined epoch (the Unix epoch for systemClock).
- Defined in packages/core/src/Clock.ts:13

setTimeout

setTimeout(fn: () => void, ms: number): unknown
Schedules fn to run after approximately ms milliseconds.
Parameters
- fn: () => void
  The callback to invoke when the delay elapses.
- ms: number
  Delay in milliseconds.
Returns unknown
An opaque handle that can be passed to clearTimeout.
- Defined in packages/core/src/Clock.ts:20

Interface Clock

Implemented by

Index

Methods

Methods

clearTimeout

Parameters

Returns void

now

Returns number

setTimeout

Parameters

Returns unknown

Settings

On This Page