Interface SystemClock

Defines interface for a system clock. This enables us to instead use a test/MockClock.MockClock for testing.

interface SystemClock {
    cancelAnimFrame(requestID): void;
    cancelCallback(timeoutID): void;
    requestAnimFrame(callback): number;
    scheduleCallback(callback, delay_ms): number;
    systemTime(): number;
}

Implemented by

Index

Methods

cancelAnimFrame cancelCallback requestAnimFrame scheduleCallback systemTime

Methods

cancelAnimFrame

cancelAnimFrame(requestID): void
cancels a request made with requestAnimFrame.
Parameters
- requestID: number
  the request ID
Returns void
- Defined in lab/util/Clock.ts:51

cancelCallback

cancelCallback(timeoutID): void
cancels a pending scheduled callback.
Parameters
- timeoutID: number
  the ID of the scheduled callback
Returns void
- Defined in lab/util/Clock.ts:33

requestAnimFrame

requestAnimFrame(callback): number
requests that the callback be executed before the next repaint.
Parameters
- callback: (() => void)
  the function to be called
  - - (): void
    - Returns void
Returns number
the request ID
- Defined in lab/util/Clock.ts:46

scheduleCallback

scheduleCallback(callback, delay_ms): number
schedules a callback to be executed in the future.
Parameters
- callback: (() => void)
  the function to be called
  - - (): void
    - Returns void
- delay_ms: number
  number of milliseconds to wait before executing the callback
Returns number
the ID of the callback
- Defined in lab/util/Clock.ts:40

systemTime

systemTime(): number
Returns the current time as given by the system clock, in seconds.

Returns number
the current time as given by the system clock, in seconds
- Defined in lab/util/Clock.ts:28

Generated using TypeDoc