Skip to content

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

License

Notifications You must be signed in to change notification settings

chrisguttandin/audio-context-timers

Repository files navigation

audio-context-timers

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

version

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 it is possible to schedule AudioBufferSourceNodes and listen for their onended event to achieve a similar result. This makes it possible to avoid the throttling.

Getting Started

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

npm install audio-context-timers

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

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

The usage is exactly the same 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);

However there are some subtle differences between audio-context-timers and WindowTimers which are the same those of the worker-timers package.