Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GlobalTimers<TTimerId>

Global methods available to every clock and also as standalone methods (inside timers global object).

Type parameters

Hierarchy

Index

Properties

Methods

Properties

Date

Date: DateConstructor

Implements the Date object but using this clock to provide the correct time.

Methods

clearImmediate

  • clearImmediate(id: TTimerId): void

  • Clears a timer, as long as it was created using setImmediate.

    Parameters

    • id: TTimerId

      Timer ID or object.

    Returns void

clearInterval

  • clearInterval(id: TTimerId): void

  • Clears a timer, as long as it was created using setInterval.

    Parameters

    • id: TTimerId

      Timer ID or object.

    Returns void

clearTimeout

  • clearTimeout(id: TTimerId): void

  • Clears a timer, as long as it was created using setTimeout.

    Parameters

    • id: TTimerId

      Timer ID or object.

    Returns void

setImmediate

  • setImmediate(callback: (...args: any[]) => void, ...args: any[]): TTimerId

  • Schedules the callback to be fired once 0 milliseconds have ticked by.

    remarks

    You'll still have to call clock.tick() for the callback to fire.

    remarks

    If called during a tick the callback won't fire until 1 millisecond has ticked by.

    Parameters

    • callback: (...args: any[]) => void

      Callback to be fired.

        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Rest ...args: any[]

      Any extra arguments to pass to the callback.

    Returns TTimerId

setInterval

  • setInterval(callback: (...args: any[]) => void, timeout: number, ...args: any[]): TTimerId

  • Schedules a callback to be fired every time timeout milliseconds have ticked by.

    Parameters

    • callback: (...args: any[]) => void

      Callback to be fired.

        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • timeout: number

      How many ticks to wait between callbacks.

    • Rest ...args: any[]

      Any extra arguments to pass to the callback.

    Returns TTimerId

    Time identifier for cancellation.

setTimeout

  • setTimeout(callback: (...args: any[]) => void, timeout: number, ...args: any[]): TTimerId

  • Schedules a callback to be fired once timeout milliseconds have ticked by.

    Parameters

    • callback: (...args: any[]) => void

      Callback to be fired.

        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • timeout: number

      How many ticks to wait to run the callback.

    • Rest ...args: any[]

      Any extra arguments to pass to the callback.

    Returns TTimerId

    Time identifier for cancellation.