@tsdotnet/observable-timer - v2.0.13
    Preparing search index...

    Class default

    A timer class that uses an Observable pattern to allow for subscribing to ticks.

    Hierarchy

    • default<number>
      • default
    Index

    Constructors

    • Parameters

      • _interval: number
      • _maxCount: number = Infinity
      • _initialDelay: number = _interval

      Returns default

    Accessors

    • get count(): number

      Returns the number of times the timer has ticked (onNext);

      Returns number

    • get isRunning(): boolean

      Returns true if the timer is running.

      Returns boolean

    Methods

    • Cancels the timer and returns true if the timer was running. Returns false if already cancelled.

      Returns boolean

    • Forces the onComplete to propagate and returns the number of times the timer ticked.

      Returns number

    • Initializes a new timer and starts it.

      Parameters

      • millisecondInterval: number
      • maxCount: number = Infinity
      • initialDelay: number = millisecondInterval

      Returns default