Class Time

Timer and date/time management interface.

You may replace this platform abstraction but we provide an implementation compatible with any standard JS environment.

Index

Constructors

Methods

getPeriodicTimer getTimer now nowMs sleep get getPeriodicTimer getTimer now nowMs register sleep unregister

Constructors

constructor

new Time(): Time
Returns Time

Methods

getPeriodicTimer

getPeriodicTimer(name, intervalMs, callback): Timer
Create a timer that will periodically call callback at intervalMs intervals.
Parameters
- name: string
- intervalMs: number
- callback: Callback
Returns Timer
- Defined in packages/general/src/time/Time.ts:45

getTimer

getTimer(name, durationMs, callback): Timer
Create a timer that will call callback after durationMs has passed.
Parameters
- name: string
- durationMs: number
- callback: Callback
Returns Timer
- Defined in packages/general/src/time/Time.ts:36

now

now(): Date
Returns Date
- Defined in packages/general/src/time/Time.ts:23

nowMs

nowMs(): number
Returns number
- Defined in packages/general/src/time/Time.ts:28

sleep

sleep(name, durationMs): CancelablePromise<void>
Create a promise that resolves after a specific interval or when canceled, whichever comes first.
Parameters
- name: string
- durationMs: number
Returns CancelablePromise<void>
- Defined in packages/general/src/time/Time.ts:54

`Static`get

get(): Time
Returns Time
- Defined in packages/general/src/time/Time.ts:21

`Static` `Readonly`getPeriodicTimer

getPeriodicTimer(name, intervalMs, callback): Timer
Parameters
- name: string
- intervalMs: number
- callback: Callback
Returns Timer
- Defined in packages/general/src/time/Time.ts:48

`Static` `Readonly`getTimer

getTimer(name, durationMs, callback): Timer
Parameters
- name: string
- durationMs: number
- callback: Callback
Returns Timer
- Defined in packages/general/src/time/Time.ts:39

`Static` `Readonly`now

now(): Date
Returns Date
- Defined in packages/general/src/time/Time.ts:26

`Static` `Readonly`nowMs

nowMs(): number
Returns number
- Defined in packages/general/src/time/Time.ts:31

`Static`register

register(timer): void
Parameters
- timer: Timer
Returns void
- Defined in packages/general/src/time/Time.ts:74

`Static`sleep

sleep(name, durationMs): CancelablePromise<void>
Parameters
- name: string
- durationMs: number
Returns CancelablePromise<void>
- Defined in packages/general/src/time/Time.ts:70

`Static`unregister

unregister(timer): void
Parameters
- timer: Timer
Returns void
- Defined in packages/general/src/time/Time.ts:79