Class: TimerManager
Defined in: TimerManager.ts:4
Manages timers so that this application can be cleanly exited
Extends
any
Constructors
new TimerManager()
new TimerManager():
TimerManager
Returns
Inherited from
null.constructor
Properties
storedIntervals
private
static
storedIntervals:Set
<Timeout
>
Defined in: TimerManager.ts:13
A set of intervals to clear on destroy
storedTimeouts
private
static
storedTimeouts:Set
<Timeout
>
Defined in: TimerManager.ts:8
A set of timeouts to clear on destroy
Methods
clearInterval()
static
clearInterval(interval
:Timeout
):void
Defined in: TimerManager.ts:55
Clears an internal created through this class
Parameters
Parameter | Type | Description |
---|---|---|
interval | Timeout | The interval to clear |
Returns
void
clearTimeout()
static
clearTimeout(timeout
:Timeout
):void
Defined in: TimerManager.ts:34
Clears a timeout created through this class
Parameters
Parameter | Type | Description |
---|---|---|
timeout | Timeout | The timeout to clear |
Returns
void
destroy()
static
destroy():void
Defined in: TimerManager.ts:63
Clears running timeouts and intervals created through this class so NodeJS can gracefully exit
Returns
void
setInterval()
static
setInterval<A
>(fn
: (...args
:A
[]) =>void
,delay
:number
, ...args
:A
[]):Timeout
Defined in: TimerManager.ts:45
Creates an interval gets cleared when destroyed
Type Parameters
Type Parameter | Default type |
---|---|
A | unknown |
Parameters
Parameter | Type | Description |
---|---|---|
fn | (...args : A []) => void | callback function |
delay | number | amount of time before running the callback |
...args | A [] | additional arguments to pass back to the callback |
Returns
Timeout
setTimeout()
static
setTimeout<A
>(fn
: (...args
:A
[]) =>void
,delay
:number
, ...args
:A
[]):Timeout
Defined in: TimerManager.ts:21
Creates a timeout gets cleared when destroyed
Type Parameters
Type Parameter | Default type |
---|---|
A | unknown |
Parameters
Parameter | Type | Description |
---|---|---|
fn | (...args : A []) => void | callback function |
delay | number | amount of time before running the callback |
...args | A [] | additional arguments to pass back to the callback |
Returns
Timeout