Add a timer to a promise by wrapping it.
$ npm i @anlerandy/timer
consttask=require('./my_asynchronous_function');constTimer=require('@anlerandy/timer');constpromise=task();constresult=awaitnewTimer(60000).launchTimer(promise);Instead of using a `setTimeout` code.
consttask=require('./my_asynchronous_function');constpromise=task();constresult=awaitnewPromise(function(resolve,reject){constid=setTimeout(reject,120000,'Timeout');try{constresult=awaitpromise;resolve(result);}catch(error){reject(error);}clearTimeout(id);})consttask=require('./my_function');constTimer=require('@anlerandy/timer');consttimer=newTimer();task(callback);launchTimer(onFailure);// Launch clock and calls onFailure if time runs outfunctioncallback(error){timer.done();// Stop the clock without calling onFailureif(error){returnonFailure();}// Do Something}functiononFailure(){// Do Something}Instanciate a timer set.time parameter is in millisecond.
Return an instance of Timer by id.
Unless options.createOne is true, return undefined if no timer was found.
Could throw if timer creation fails.
consttimer=Timer.getById('myTaskId');awaittimer.launchTimer(task());Return an array of all saved timer instances.
Delete all saved timer instances that are not running.
Only time property can be set (timer.time = 2000). Will not be updated if value is not a number.
Changing time while Timer is running can result in a timeout.
| Property | Type | Default | Description |
|---|---|---|---|
| _id | String | N/A | id of the instance |
| createdAt | Date | N/A | Creation date |
| startedAt | Date | undefined | Launch date |
| lastUpdate | Date | createdAt | Last update (i.e. last postpone) |
| inProgress | boolean | false | True if running |
| isAborted | boolean | false | True if cancelled |
| isSelfAborted | boolean | false | True if the timer cancelled its task |
| time | Number | 120000 | Time to wait before timeout (ms) |
All properties are undefined if the instance is being deleted.
consttimer=newTimer();timer.destroy();constdate=timer.createdAt;console.log(date);// output: undefinedRun the timer.
If callback argument is a function, it returns undefined.
If it's a Promise, it will return a Promise.
Terminate timer without triggering callback or promise.reject.
If destroy option was true on instanciation, deletes the timer.
Destroy the instance.
Throw an error if instance is not terminated via _.done() or _.abort().
Automaticaly called after termination if destroy option was set as true.
Reset the clock of timer.
Useful if there is multiple task to be done, and each should be under the same timer.
Run callback or promise.reject. Then, work as timer.done().
Can be used to terminate a task if the said task verify if timer is aborted.