SuperTimeout-JS

Ever wished you could pause and unpause the ticking of all setTimeouts and setIntervals in your app?

With this javascript library you can replace them with SuperTimeouts and SuperIntervals and do just that.

Examples

See a demo of SuperTimeout, the pausable version of setTimeout (See supertimeout_example.html)

See a demo of SuperInterval, the pausable version of setInterval (See superinterval_example.html)

Usage

Creating a SuperTimeout is very similar to creating a setTimeout. Just don't forget to start with the keyword « new ».

new SuperTimeout(doSomething, 2000);

Note the same resemblance between SuperInterval and setInterval.

new SuperInterval(doSomething, 2000);

Especially useful in situations where you just have to keep adding to the chain of timeouts like,

new SuperTimeout(doSomething, 3000);
function doSomething() {
  console.log("First task complete!");
  new SuperTimeout(doOneMoreThing, 4000);
}
function doOneMoreThing() {
  console.log("Second task complete!");
  new SuperTimeout(doTheNextOtherThing, 5000);
}
function doTheNextOtherThing() {
  console.log("Third task complete!");
  // You get the idea...
}

As you can now pause the chain of all timeouts and all intervals easily and unpause as well by calling

• pauseAllSuperTimers()
• unpauseAllSuperTimers()

That is, of course, no matter how long the chain is.

REMEMBER: SuperTimer functions will not pause or unpause the regular ECMAScript setTimeouts and setIntervals!

SuperTimer functions can only pause and unpause SuperTimeouts and SuperIntervals!

Note that if you want to control individual timers, you must assign them to variables with names like so

const oneParticularTimer = new SuperTimeout(doSomething, 3000);

as this will allow you to use methods on any given timer, like oneParticularTimer.pause(); or oneParticularTimer.resume(); or oneParticularTimer.clear(); or oneParticularTimer.restart();

Methods

.pause(), .resume(), .clear() and .restart() methods can be used both on a SuperTimeout and a SuperInterval.

Properties

remainingTime property can be used both on a SuperTimeout and a SuperInterval to get the remaining number of milliseconds at the moment of pausing. Example: oneParticularTimer.remainingTime

See the source code .

Warning

When clearing SuperTimeout and SuperInterval timers using .clear() what you must be careful about is,

• clearTimeout(myTimeout) and clearInterval(myInterval) do not throw any errors if myTimeout or myInterval is undefined,
• myTimeout.clear() or myInterval.clear() will throw an error if myTimeout or myInterval is undefined.

In order to simulate a perfect app-freeze and app-unfreeze you must get all the playing audio and video and pause them too along with your super timers. Note that CSS animations can also be paused by changing their .style.animationPlayState from running to paused.

Installation

Either get supertimeout.js and include it in your HTML like,

<script src="/the/path/to/supertimeout.js">/*Pausable timeouts and intervals*/</script>

or use a CDN like,

https://cdn.jsdelivr.net/gh/TopraksoyEarthmanTsuchimoto/SuperTimeout-JS@main/supertimeout.js

Developers

You may create a fork of this repository under the terms stated in the license.

History

supertimeout.js has been created during the development of THE SPEAKWORLDLANGUAGES WEB APP