worker-timers

What is worker-timers?

The worker-timers npm package provides timer functions (setTimeout, setInterval, and clearTimeout) that run in Web Workers. This allows for more accurate timing and less interference from the main thread, which can be beneficial for performance-sensitive applications.

What are worker-timers's main functionalities?

setTimeout

The setTimeout function schedules a function to be executed after a specified delay, in milliseconds. This is similar to the native setTimeout but runs in a Web Worker for more accurate timing.

const { setTimeout } = require('worker-timers');

setTimeout(() => {
  console.log('This runs after 1000ms');
}, 1000);

setInterval

The setInterval function repeatedly calls a function with a fixed time delay between each call. This is similar to the native setInterval but runs in a Web Worker for more consistent intervals.

const { setInterval } = require('worker-timers');

setInterval(() => {
  console.log('This runs every 1000ms');
}, 1000);

clearTimeout

The clearTimeout function cancels a timeout previously established by calling setTimeout. This is similar to the native clearTimeout but works with the worker-timers setTimeout.

const { setTimeout, clearTimeout } = require('worker-timers');

const timeoutId = setTimeout(() => {
  console.log('This will not run');
}, 1000);

clearTimeout(timeoutId);

clearInterval

The clearInterval function cancels a repeated action which was established by a call to setInterval. This is similar to the native clearInterval but works with the worker-timers setInterval.

const { setInterval, clearInterval } = require('worker-timers');

const intervalId = setInterval(() => {
  console.log('This will not run');
}, 1000);

clearInterval(intervalId);

Other packages similar to worker-timers

worker-timer

The worker-timer package provides similar functionality by running timer functions in Web Workers. It aims to provide more accurate timing and less interference from the main thread, similar to worker-timers.

README

worker-timers

A replacement for setInterval() and setTimeout() which works in unfocused windows.

Motivation

For scripts that rely on WindowTimers like setInterval() or setTimeout() things get confusing when the site which the script is running on loses focus. Chrome, Firefox and maybe others throttle the frequency at which they invoke those timers to a maximum of once per second in such a situation. However this is only true for the main thread and does not affect the behavior of Web Workers. Therefore it is possible to avoid the throttling by using a worker to do the actual scheduling. This is exactly what worker-timers does.

Getting Started

worker-timers is available as a package on npm. Run the following command to install it:

npm install worker-timers

You can then import the exported functions in your code like this:

import { clearInterval, clearTimeout, setInterval, setTimeout } from 'worker-timers';

The usage is exactly the same (despite of the error handling and the differentiation between intervals and timeouts) as with the corresponding functions on the global scope.

var intervalId = setInterval(() => {
    // do something many times
}, 100);

clearInterval(intervalId);

var timeoutId = setTimeout(() => {
    // do something once
}, 100);

clearTimeout(timeoutId);

Differentiation between Intervals and Timeouts

The native WindowTimers only maintain a single list of timers. But worker-timers maintains two separate lists to store the ids of intervals and timeouts internally. WindowTimers allows intervals to be cancelled by calling clearTimeout() and the other way round because it stores all timers in a single list. This is not possible with worker-timers.

const periodicWork = () => {};

// This will stop the interval.
const windowId = window.setInterval(periodicWork, 100);
window.clearTimeout(windowId);

// This will not cancel the interval. It may cancel a timeout.
const workerId = setInterval(periodicWork, 100);
clearTimeout(workerId);

Server-Side Rendering

This package is intended to be used in the browser and requires the browser to have support for Web Workers. It does not contain any fallback which would allow it to run in another environment like Node.js which doesn't know about Web Workers. This is to prevent this package from silently failing in an unsupported browser. But it also means that it needs to be replaced when used in a web project which also supports server-side rendering. The replacement should be straightforward, at least in theory, because each function has the exact same signature as its corresponding builtin function. But the configuration of a real-life project can be tricky. For a concrete example, please have a look at the worker-timers-ssr-example provided by @newyork-anthonyng. It shows the usage inside of a server-side rendered React app.

Angular (& Zone.js)

If worker-timers is used inside of an Angular app and Zone.js (which is the default) is used to detect changes, the behavior of worker-timers can be confusing. Angular is using Zone.js which is patching the native setInterval() and setTimeout() functions to get notified about the invocation of their callback functions. But Angular (more specifically Zone.js) is not aware of worker-timers and doesn't get notified about any callback invocations. Therefore Angular needs to be notified manually about state changes that occur inside of a callback function which was scheduled with the help of worker-timers.

Security contact information

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.