Package timer

@typed/timer

Interfaces for working with time. Immensely useful for testing time dependent functionality.

Index

Classes

Timeline

Interfaces

Type aliases

RequestIdleCallbackDeadline

Functions

Type aliases

RequestIdleCallbackDeadline

RequestIdleCallbackDeadline: { didTimeout: boolean; timeRemaining: () => number }

Type declaration

Readonly didTimeout: boolean
timeRemaining: () => number
- - (): number
  - Returns number

Functions

Const createClock

createClock(): Clock

- Defined in packages/timer/source/clock.ts:8
Returns Clock

Const createRelativeClock

createRelativeClock(clock: Clock): Clock

- Defined in packages/timer/source/clock.ts:5
Create a clock relative to the current time

Parameters
- clock: Clock
Returns Clock

createSetTimeoutTimer

createSetTimeoutTimer(clock: Clock): Timer

- Defined in packages/timer/source/createSetTimeoutTimer.ts:10
Createa timer from a clock and setTimeout. Also tries to run tasks with delay of 0 using micro-tasks by way of a Promise.

Parameters
- clock: Clock
Returns Timer

createTimer

createTimer(): Timer

- Defined in packages/timer/source/createTimer.ts:8
Create a timer based on Performance and setTimeout

Returns Timer

createVirtualClock

createVirtualClock(currentTime?: number): VirtualClock

- Defined in packages/timer/source/createVirtualClock.ts:7
Create a VirtualClock

Parameters
- Default value currentTime: number = 0
  
  (optional) :: Time to start at
Returns VirtualClock

createVirtualTimer

createVirtualTimer(clock?: VirtualClock): VirtualTimer

- Defined in packages/timer/source/createVirtualTimer.ts:11
Create a VirtualTimer. Useful for testing.

Parameters
- Default value clock: VirtualClock = createVirtualClock()
Returns VirtualTimer

interval

interval(fn: Arity1<number, Disposable>, interval: number, timer: Timer): Disposable

- Defined in packages/timer/source/interval.ts:12
Call a function at a given interval using a Timer.

Parameters
- fn: Arity1<number, Disposable>
  
  :: (number -> *)
- interval: number
  
  :: number
- timer: Timer
  
  :: Timer
Returns Disposable

:: Disposable

whenIdle

whenIdle(fn: Arity2<RequestIdleCallbackDeadline, number>, timer: Timer): Disposable

- Defined in packages/timer/source/whenIdle.ts:32
Attempts to schedule a task to be performed when the event queue is clear.

Parameters
- fn: Arity2<RequestIdleCallbackDeadline, number>
  
  :: ({ didTimeout:: boolean; timeRemaining :: (* -> number) } -> number -> *)
- timer: Timer
  
  :: Timer
Returns Disposable

Disposable

whenIdleWithTimeout

whenIdleWithTimeout(fn: Arity2<RequestIdleCallbackDeadline, number>, timeout: number, timer: Timer): Disposable

- Defined in packages/timer/source/whenIdle.ts:48
Run a function when idle when in a browser falling back to a specified timeout within node.

Parameters
- fn: Arity2<RequestIdleCallbackDeadline, number>
  
  :: (RequestIdleCallbackDeadline -> number -> *)
- timeout: number
  
  :: number
- timer: Timer
  
  :: Timer
Returns Disposable

Disposable

Generated using TypeDoc