Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • TimerOptions

Index

Properties

Optional clearInterval

clearInterval: (id: any) => void

low-level, custom function that can stop a custom function.

Type declaration

    • (id: any): void
    • Parameters

      • id: any

      Returns void

Optional divider

divider: string

what Timer.getFullTimeUI uses to separate each unit of time. Default ":"

Optional finalInterval

finalInterval: boolean

when true, onInterval is called when the timer reaches 0 (usually desired). Default true

Optional immediateInterval

immediateInterval: boolean

when true, the timer ticks down by one immediately, and the onInterval function runs, if passed.

interval

interval: number

Optional onInterval

onInterval: Function

a function that's called on each "tick", or when the timer decrements a second

Optional onTimeout

onTimeout: Function

a function that's ran when the timer reaches 0

Optional repeat

repeat: number

if true, resets the timer to its original time, and begins counting down again

Optional setInterval

setInterval: intervalFn

low-level, custom function that executes its callback every timeout milliseconds, must return an identifier that can be passed to TimerOptions.loopClear to stop execution.

Optional startPaused

startPaused: boolean

if true, timer will start paused at its initial time, and must be unpaused to count down.

Legend

  • Interface
  • Property
  • Function
  • Class

Generated using TypeDoc