|
|
|
@ -84,7 +84,8 @@ After 500ms:
|
|
|
|
|
Returns a new `timerObject`. The returned timer does *not* start running until you call its `start` method!
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
- __options:__
|
|
|
|
|
|
|
|
|
|
- __options:__
|
|
|
|
|
- __timeout:__ The timeout, in milliseconds, after which the timer should 'fire' by default.
|
|
|
|
|
- __onFire:__ A callback that will be called when the timer fires (ie. hits the timeout).
|
|
|
|
|
- __onCancel:__ *Optional.* A callback that will be called when the timer is cancelled (ie. stopped prematurely).
|
|
|
|
@ -94,7 +95,8 @@ Arguments:
|
|
|
|
|
Starts the timer (anew), first stopping it if it's already running.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
- __options:__ *Optional.* These settings will override the options that were used to create the `timerObject`, but *only* for this run.
|
|
|
|
|
|
|
|
|
|
- __options:__ *Optional.* These settings will override the options that were used to create the `timerObject`, but *only* for this run.
|
|
|
|
|
- __timeout:__ *Optional.* The timeout, in milliseconds, after which the timer should 'fire' on *this run*.
|
|
|
|
|
- __onFire:__ *Optional.* A callback that will be called when the timer fires on *this run*.
|
|
|
|
|
- __onCancel:__ *Optional.* A callback that will be called when *this run* of the timer is cancelled.
|
|
|
|
@ -109,6 +111,10 @@ Returns a boolean indicating whether the timer is currently running or not.
|
|
|
|
|
|
|
|
|
|
## Changelog
|
|
|
|
|
|
|
|
|
|
### 1.0.1 (August 25, 2019)
|
|
|
|
|
|
|
|
|
|
- Fixed documentation formatting.
|
|
|
|
|
|
|
|
|
|
### 1.0.0 (August 25, 2019)
|
|
|
|
|
|
|
|
|
|
Initial release.
|
|
|
|
|