Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAlarm

Represents an alarm that executes something when the timer goes off. The interface doesn't involve the code execution or the timer definition. It exposes only methods and properties useful before or after the timer ends. When the Alarm goes off, it can be stopped or snoozed by a specific amount of time (milliseconds).

Hierarchy

  • IAlarm

Implemented by

Index

Properties

Methods

Properties

expired: boolean
stopped: boolean

Methods

  • snooze(time: number): void
  • Parameters

    • time: number

      Snooze time in milliseconds. If greater than the delta between 'now' and the 'expiration', the delta is used

    Returns void

  • stop(): void

Generated using TypeDoc