tickable-timer
Manual ticking timer API for test CI
Features
- Compatible with the native timer API
- Provides hook events before/after ticking
Installation
npm install tickable-timer
API
Properties
timers: number[]
intervals: number[]
timeouts: number[]
Methods
Inherits methods from EventEmitter.
setTimeout(callback: function, delay: number, ...params: any): number
clearTimeout(timerId: number): void
setInterval(callback: function, delay: number, ...params: any): number
clearInterval(timerId: number): void
tick(tick: number = 1): void
clearAllTimers(): void
Events
tick
tick: number
The ticking interval
ticked
tick: number
The ticking interval
Usage
{ let emitter = ; let count = start; let timerId = timerAPI; return emitter;} // in the production (use native timer); // in the test (use tickable timer); ;
Example
; tickable; tickable; tickable; tickable; tickable; tickable;tickable; tickable;
output:
tick: 500
fired: timer2
ticked: 500
tick: 500
fired: timer1
fired: timer2
ticked: 500
tick: 500
fired: timer2
ticked: 500
tick: 500
fired: timer2
ticked: 500
tick: 500
fired: timer2
clear: all timers
timers: []
ticked: 500
tick: 2500
ticked: 2500
License
MIT