daily-intervals
v3.0.7
Published
Create intervals that are based on the time
Downloads
17
Readme
daily-intervals
Create intervals that are based on the time
Usage
import {
setDailyInterval,
clearDailyInterval
} from 'daily-intervals';
/*
This executes every 2 hours
The intervals start at 1 am
Meaning the times it will execute will be:
This is the given starting time
|
V
..., 21:00, 23:00, 1:00, 3:00, 5:00, 7:00, ...
The interval will not wait until the current time has reached the starting time to execute the callback function. The closest interval will be used as the time to execute the function.
Example:
Current time: 22:34
Execution time Starting time
| |
V V
..., 21:00, 23:00, 1:00, 3:00, 5:00, 7:00, ...
The callback function will be executed at 23:00 in this example
*/
setDailyInterval(() => {
console.log('hello world');
}, 2 * 60, '1:00');
//------------------
// similar usage to setTimeout and setInterval
setDailyInterval(() => {
console.log('Hello world 1');
});
setDailyInterval(() => {
console.log('Hello world 2');
}, 2);
setDailyInterval(() => {
console.log('Hello world 3');
}, 3, '3:33');
setDailyInterval((a, b, c) => {
console.log(a, b, c);
}, 4, '4:44', '1', '2', '3');
setDailyInterval("console.log('Hello world 4');");
//------------------
// clearing a dailyInterval
const id = setDailyInterval(() => console.log('cleared'));
clearDailyInterval(id);