timide

Yet another resumable timer

Usage no npm install needed!

<script type="module">
  import timide from 'https://cdn.skypack.dev/timide';
</script>

README

timide

Yet another resumable timer

Table of Contents

Install

$ npm install timide

Usage

const {Timer} = require('timide');

const timer = new Timer({
  // The initial state (default: `[false, 0, 0]`)
  state: [false, 1598126121368, -20000],

  // The tick interval (default: `100`)
  interval: 100,
});

timer.on('state', (value) => {
  // Emitted when the state changes
});

timer.on('time', (value) => {
  // Emitted when the interval ticks or the state changes
});

// Starts the timer
timer.start();

// Stops the timer
timer.stop();

// Starts the timer including the missed time if stopped
timer.start(true);

// Updates the timer time
timer.seek(20000);

// Resets the timer
timer.reset();

API

See the declaration file.

Author

Alexandre Breteau - @0xSeldszar

License

MIT © Alexandre Breteau