@slimio/timer

SlimIO - NodeJS Driftless & Safe Timers

Usage no npm install needed!

<script type="module">
  import slimioTimer from 'https://cdn.skypack.dev/@slimio/timer';
</script>

README

Timer

Version Maintenance MIT dep size Known Vulnerabilities Build Status Greenkeeper badge

SlimIO - Node.js Driftless Interval Timer. This package is inspired by driftless

⚠️ This package is experimental (Please dont use it outside).

Requirements

Getting Started

This package is available in the Node Package Repository and can be easily installed with npm or yarn.

$ npm i @slimio/timer
# or
$ yarn add @slimio/timer

Why

Node.js timer (interval and timeout) drift with the time. This package aim to implement a no-drift setInterval.

Usage example

const timer = require("@slimio/timer");

const timerId = timer.setInterval(() => {
    console.log("hello world!");
}, 1000);

// Later...
timer.clearInterval(timerId);

API

timer.setInterval(handler: Function, intervalMs: number): number

Create a new interval. Same API as Node.js !

timer.clearInterval(intervalId: number): void

Clear a given interval id (the number returned by setInterval).

Dependencies

This project have no dependencies.

License

MIT