Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Timeout

Hierarchy

  • TimingFunction
    • Timeout

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Timeout(fn: Function, ms: number): Timeout

Properties

canceled

canceled: boolean = false

Whether current timing function has been canceled.

fn

fn: Function

The original function.

ms

ms: number

Get or set the associated time interval in milliseconds.

Methods

cancel

  • cancel(): boolean
  • Cancel deferred function. Returns true if it was not been canceled.

    Returns boolean

flush

  • flush(): boolean
  • Call deferred function immediately if it wasn't been called. Returns true if not called yet.

    Returns boolean

reset

  • reset(): true

Generated using TypeDoc