A simple library to manage timeouts and intervals.
First you need to import it in your project
The require way
let{ createInterval, destroyInterval, TimeUnit }=require("timer-creator");The import way
import{createTimeout,destroyTimeout,TimeUnit}from"timer-creator";Then use it to establish a periodic callback execution until condition
import{createInterval,destroyInterval,TimeUnit}from"timer-creator";constTIMER_NAME='myIntervalName'functionmyFunction(){// YOUR OWN CODE AND STUFFhasConditionMeeted&&destroyInterval(TIMER_NAME)}createInterval(TIMER_NAME,myFunction,2*TimeUnit.MINUTE)Or one time callback execution
import{createTimeout,TimeUnit}from"timer-creator";functionmyFunction(arg1,arg2){// YOUR OWN CODE AND STUFF}createTimeout('myTimeoutName',myFunction,30*TimeUnit.SECOND,[arg1,arg2])Additional JSDOC info
- TimeUnit
- existInterval
- getInterval
- createInterval
- destroyInterval
- existTimeout
- getTimeout
- createTimeout
- destroyTimeout
Contains time unit constants
Type: object
Time unit referent to Milisecond
Type: number
Time unit referent to Second in miliseconds
Type: number
Time unit referent to Minute in miliseconds
Type: number
Time unit referent to Hour in miliseconds
Type: number
Time unit referent to Day in miliseconds
Type: number
Checks whether exist interval with given name.
namestring interval name
Returns boolean true or false wheter interval is stored or not
Retrieves interval value for given name.
namestring interval name
Returns number interval number reference
Creates and _store interval object with given name, to execute callback function on the waitTime specified with given args.
namestring interval namecallbackFunction the function to be executed as a callbackwaitTimenumber the waiting time for the intervalargs(string | Array | null) arguments to be passed to the callback function
Destroy interval with given name and removes it from _store.
namestring interval name
Checks whether exist timeout with given name.
namestring timeout name
Returns boolean true or false wheter timeout is stored or not
Retrieves timeout value for given name.
namestring timeout name
Returns number timeout number reference
Creates and store timeout object with given name, to execute callback function on the waitTime specified with given args, its removed from store when callback is executed.
namestring timeout namecallbackFunction the function to be executed as a callbackwaitTimenumber the waiting time for the timeoutargs(string | Array | null) arguments to be passed to the callback function
Destroy timeout with given name and removes it from store.
namestring timeout name
Contains time unit constants
Type: Object
Time unit referent to Milisecond
Type: number
Time unit referent to Second in miliseconds
Type: number
Time unit referent to Minute in miliseconds
Type: number
Time unit referent to Hour in miliseconds
Type: number
Time unit referent to Day in miliseconds
Type: number
Checks whether exist interval with given name.
namestring interval name
Returns boolean true or false wheter interval is stored or not
Retrieves interval value for given name.
namestring interval name
Returns number interval number reference
Creates and _store interval object with given name, to execute callback function on the waitTime specified with given args.
namestring interval namecallbackFunction the function to be executed as a callbackwaitTimenumber the waiting time for the intervalargs(string | Array | null) arguments to be passed to the callback function
Destroy interval with given name and removes it from _store.
namestring interval name
Checks whether exist timeout with given name.
namestring timeout name
Returns boolean true or false wheter timeout is stored or not
Retrieves timeout value for given name.
namestring timeout name
Returns number timeout number reference
Creates and store timeout object with given name, to execute callback function on the waitTime specified with given args, its removed from store when callback is executed.
namestring timeout namecallbackFunction the function to be executed as a callbackwaitTimenumber the waiting time for the timeoutargs(string | Array | null) arguments to be passed to the callback function
Destroy timeout with given name and removes it from store.
namestring timeout name