@anlerandy/timer v2.0.0-5

Timer v^2.0.0

Add a timer to a promise by wrapping it.

Install

$ npm i @anlerandy/timer

Usage

// ES6
import Timer from '@anlerandy/timer';
// CommonJS
var Timer = require('@anlerandy/timer').default;

Promise

const task = require('./my_asynchronous_function');
const Timer = require('@anlerandy/timer');

const promise = task();
// Your function has 60'000ms (1minute) to finish
const result = await new Timer(60000).launchTimer(promise);

const promise = task();
const result = await new Promise(function (resolve, reject) {
  const id = setTimeout(reject, 120000, 'Timeout');
  try {
    const result = await promise;
    resolve(result);
  } catch (error) {
    reject(error);
  }
  clearTimeout(id);
})

</details>


## Callback

```javascript
const task = require('./my_function');
const Timer = require('@anlerandy/timer');

const timer = new Timer();

task(callback);
launchTimer(onFailure); // Launch clock and calls onFailure if time runs out

function callback(error) {
  timer.done(); // Stop the clock without calling onFailure
  if (error) {
    return onFailure();
  }
  // Do Something
}

function onFailure() {
  // Do Something
}

Cron

// toCronTask is async
const toCronTask = require('./my_function_to_cron');
const Timer = require('@anlerandy/timer');

const cronId = 'cron-id';

function start() {
  // Create and save cron. If aborted/done, will self destruct (destroy: true)
  Timer.getById(cronId, { createOne: true, destroy: true });
  return loop();
}

function stop() {
  const cron = Timer.getById(cronId);
  // Unless already stop, it should exist since `start` call
  if (cron) {
    // Will be destroyed after done
    cron.done();
  }
}

function loop() {
  toCronTask().finaly(() => {
    // It was created in `start`
    const cron = Timer.getById(cronId);
    // Unless `cron` is destroyed, repeat `loop`
    if (cron) {
      // You can also verify if accidently launched and keep it from launching twice
      // if (!cron.inProgress)
      cron.launchTimer(loop);
    }
  });
}

Instance properties

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.

All properties are undefined or 0 if the instance is being deleted.

const timer = new Timer();
timer.destroy();
const date = timer.createdAt;
const time = timer.time;
console.log(date, time);
// output: undefined, 0

Instance API

timer.launchTimer(callback: function | promise, argument?)

Run the timer.
If callback argument is a function, it returns undefined.
If it's a Promise, it will return a Promise.

timer.launchOrUpdate(callback: function | promise, argument?)

Run the timer or update it if already inProgress.

timer.done()

Terminate timer without triggering callback or promise.reject.
If destroy option was true on instanciation, deletes the timer.

timer.destroy()

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.

timer.update()

Reset the clock of timer.
Useful if there is multiple task to be done, and each should be under the same timer.

timer.abort()

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.