pause-me v1.3.0

pause-me, A Dependency Free setTimeout Utility

[ pause-me on npm ]

The "pause-me" utility allows pausing, resuming, stopping and starting a setTimeout.

Install

  $ npm install pause-me --save  

Node

      const pauseMe = require("pause-me");  

Use it like you would a setTimeout

	  const myTimeout = pauseMe(() => {  
		console.log("timed out!");
	  }, 5000);

or

	  const myTimeoutFunc = () => {
		console.log("timed out!");
	  };

	  const myTimeout = pauseMe(myTimeoutFunc, 5000);  

Added in 1.1.0

You can also use it as a setInterval by setting the repeating parameter to true.

	   let counter = 0;
	   const myInterval = pauseMe(() => {  
		counter++;
		console.log("Interval " + counter);
	  }, 5000, true);

When the setTimeout is finished it immediately restarts in order to behave like an setInterval.

pause

Then you can pause the timeout anywhere myTimeout is in scope.

	  myTimeout.pause();  

resume

When you are ready, you can then resume the timeout anywhere myTimeout is in scope.

	  myTimeout.resume();  

stop

If you want to clear the time out, just call stop()

	  myTimeout.stop();  

This does not remove myTimeout from the scope.

start

So you can still start the timeout from the beginning again if you want to.

	  myTimeout.start();  

Added in 1.3.0

restart

So you can restart the timeout at any point.

    myTimeout.restart();

timer

Also added in 1.1.0, you can test the setTimeout instance to see whether or not it is still running.

	  if (myTimeout.timer() === null) {  
	    //myTimeout is not running
	  }
	  else {
	    //myTimeout is running
	  }

Possible Breaking Change in 1.3.0

Previously, stop would not do anything if the timeout was paused. This behavior is not intuitive, so now stop will clear the timeout and reset the timer even if the timeout is paused.

License

Published under the MIT license.