What's the difference between recursive setTimeout versus setInterval?
Asked Answered
B

19

808

As far as I can tell, these two pieces of javascript behave the same way:

Option A:

function myTimeoutFunction()
{
    doStuff();
    setTimeout(myTimeoutFunction, 1000);
}

myTimeoutFunction();

Option B:

function myTimeoutFunction()
{
    doStuff();
}

myTimeoutFunction();
setInterval(myTimeoutFunction, 1000);

Is there any difference between using setTimeout and setInterval?

Bailment answered 8/4, 2009 at 13:11 Comment(5)
If you would like some good details on how timers in JS work, John Resig wrote a good article on this topicCradling
there's also the obvious difference that setTimeout requires that extra line of code to keep it propagating, which has the drawback of being a maintenance problem but the benefit of letting you change the period easilyDirections
try this jsfiddle.net/pramendra/Y4vEVKiddush
Thanks @JapanPro but I never really had a problem getting timeouts working. This post was about what the difference was and which should be used.Bailment
Update link. Edit queue is full setTimeout VS setIntervalScabies
C
709

They essentially try to do the same thing, but the setInterval approach will be more accurate than the setTimeout approach, since setTimeout waits 1000ms, runs the function and then sets another timeout. So the wait period is actually a bit more than 1000ms (or a lot more if your function takes a long time to execute).

Although one might think that setInterval will execute exactly every 1000ms, it is important to note that setInterval will also delay, since JavaScript isn't a multi-threaded language, which means that - if there are other parts of the script running - the interval will have to wait for that to finish.

In this Fiddle, you can clearly see that the timeout will fall behind, while the interval is almost all the time at almost 1 call/second (which the script is trying to do). If you change the speed variable at the top to something small like 20 (meaning it will try to run 50 times per second), the interval will never quite reach an average of 50 iterations per second.

The delay is almost always negligible, but if you're programming something really precise, you should go for a self-adjusting timer (which essentially is a timeout-based timer that constantly adjusts itself for the delay it's created)

Cropeared answered 8/4, 2009 at 13:14 Comment(7)
Andy had a similar suggestion. Hypothetically, does this mean that if the method takes more than 1000ms to execute, you can have more than one running simultaneously?Bailment
Theoratically, yes. In practise, no since Javascript does not support multithreading. If your code takes longer than 1000ms, it will freeze the browser.Eileen
Technically, the code wont execute exactly every 1000ms, since it depends on the resolution of the timer and whether other code is already executing. Your point still stands though.Hilliard
Note an interval can still be delayed or dropped if you're failing to service it in time (see below).Mellicent
setInterval is different in two ways,1. setInterval is not recursive and setInterval will first time call your function after told time while setTimeout first time being called without any delay and after that it will call again after told time. After first execution they work almost same.Bashibazouk
The difference is that setTimeout does not repeat itself. It allows you to run a script after a set time, but only once. The setInterval on the other hand will repeat that script, untill it is stopped with clearTimeout().Largeminded
Also we have control by timeout period length in setTimeout, in setInterval not... And really not difference between clearTimeout and clearIntervalEidson
M
666

Is there any difference?

Yes. A Timeout executes a certain amount of time after setTimeout() is called; an Interval executes a certain amount of time after the previous interval fired.

You will notice the difference if your doStuff() function takes a while to execute. For example, if we represent a call to setTimeout/setInterval with ., a firing of the timeout/interval with * and JavaScript code execution with [-----], the timelines look like:

Timeout:

.    *  .    *  .    *  .    *  .
     [--]    [--]    [--]    [--]

Interval:

.    *    *    *    *    *    *
     [--] [--] [--] [--] [--] [--]

The next complication is if an interval fires whilst JavaScript is already busy doing something (such as handling a previous interval). In this case, the interval is remembered, and happens as soon as the previous handler finishes and returns control to the browser. So for example for a doStuff() process that is sometimes short ([-]) and sometimes long ([-----]):

.    *    *    •    *    •    *    *
     [-]  [-----][-][-----][-][-]  [-]

• represents an interval firing that couldn't execute its code straight away, and was made pending instead.

So intervals try to ‘catch up’ to get back on schedule. But, they don't queue one on top of each other: there can only ever be one execution pending per interval. (If they all queued up, the browser would be left with an ever-expanding list of outstanding executions!)

.    *    •    •    x    •    •    x
     [------][------][------][------]

x represents an interval firing that couldn't execute or be made pending, so instead was discarded.

If your doStuff() function habitually takes longer to execute than the interval that is set for it, the browser will eat 100% CPU trying to service it, and may become less responsive.

Which do you use and why?

Chained-Timeout gives a guaranteed slot of free time to the browser; Interval tries to ensure the function it is running executes as close as possible to its scheduled times, at the expense of browser UI availability.

I would consider an interval for one-off animations I wanted to be as smooth as possible, whilst chained timeouts are more polite for ongoing animations that would take place all the time whilst the page is loaded. For less demanding uses (such as a trivial updater firing every 30 seconds or something), you can safely use either.

In terms of browser compatibility, setTimeout predates setInterval, but all browsers you will meet today support both. The last straggler for many years was IE Mobile in WinMo <6.5, but hopefully that too is now behind us.

Mellicent answered 8/4, 2009 at 20:13 Comment(8)
But does the reason of choice between Interval and Timeout hold true even non-browser platforms, like for instance WebOS or JIL?Meed
A nice way of doing chained timeouts on anonymous functions: setTimeout(function(){ setTimeout(arguments.callee,10) },10)Glycogenesis
In terms of browser compatibility, although all browsers provide both methods, their performance is different.Haleakala
"But then chances are it doesn't support anything else you're using either" so very trueAbisha
drum machine by chromium project using setTimeout("schedule()", 0); So browser won't have unnecessary stack when it is background tab for chrome or lack of resources.Sphacelus
When you say the interval gets dropped...you mean for that particular time...i.e. if I have 100 intervals...they will all indeed run at some point. A drop just means that some will run later then if they had not been dropped?Curtsy
@JustinMeyer at the time using arguments.callee was a great solution. Using that method is now deprecated. Named functions are acceptable though.Patmos
@Mellicent you wrote: "The next complication is if an interval fires whilst JavaScript is already busy doing something (such as handling a previous interval). In this case, the interval is remembered, and happens as soon as the previous handler finishes and returns control to the browser." I noticed that this mostly happens when you leave browser or tab. Is there a workaround for this? Or maybe some example of implementing own interval in pure JS?Ibiza
S
98

setInterval()

setInterval() is a time interval based code execution method that has the native ability to repeatedly run a specified script when the interval is reached. It should not be nested into its callback function by the script author to make it loop, since it loops by default. It will keep firing at the interval unless you call clearInterval().

If you want to loop code for animations or on a clock tick, then use setInterval().

function doStuff() {
    alert("run your code here when time interval is reached");
}
var myTimer = setInterval(doStuff, 5000);

setTimeout()

setTimeout() is a time based code execution method that will execute a script only one time when the interval is reached. It will not repeat again unless you gear it to loop the script by nesting the setTimeout() object inside of the function it calls to run. If geared to loop, it will keep firing at the interval unless you call clearTimeout().

function doStuff() {
    alert("run your code here when time interval is reached");
}
var myTimer = setTimeout(doStuff, 5000);

If you want something to happen one time after a specified period of time, then use setTimeout(). That is because it only executes one time when the specified interval is reached.

Striped answered 14/8, 2013 at 5:12 Comment(2)
Nice explanation but note that the OP understands the basic difference in the examples the OP provided. In particular, note that in the OP's setTimeout() example, setTimeout() is called recursively, whereas setInterval() is not.Tented
The best explanation.Boyar
E
45

The setInterval makes it easier to cancel future execution of your code. If you use setTimeout, you must keep track of the timer id in case you wish to cancel it later on.

var timerId = null;
function myTimeoutFunction()
{
    doStuff();
    timerId = setTimeout(myTimeoutFunction, 1000);
}

myTimeoutFunction();

// later on...
clearTimeout(timerId);

versus

function myTimeoutFunction()
{
    doStuff();
}

myTimeoutFunction();
var timerId = setInterval(myTimeoutFunction, 1000);

// later on...
clearInterval(timerId);
Eileen answered 8/4, 2009 at 13:25 Comment(4)
I don't see how you are not keeping track of the timer id in the case of setInterval. It's just pulled out of the function.Epicotyl
Another option with setTimeout is rather than saving the id add an if statement to only set the next timeout when some condition is true.Gilford
Kekoa, good point. But you have to save the interval id only once. The timeout id is probably changing with every invocation, so you have to keep track of these changes. Code that wants to clear the timeout has to somehow have access to the current value of this variable. Additionally it is impossible to clear the timeout while running doStuff because the id is invalid. However, it's not really necessary to save timeout ids. Instead you can just stop calling setTimeout.Co
In my experience, most of the time you want to be able to cancel even while using setTimeout. 99% of the time you want to cancel before the next invocation occurs, not after the next one finishes.Eileen
R
23

I find the setTimeout method easier to use if you want to cancel the timeout:

function myTimeoutFunction() {
   doStuff();
   if (stillrunning) {
      setTimeout(myTimeoutFunction, 1000);
   }
}

myTimeoutFunction();

Also, if something would go wrong in the function it will just stop repeating at the first time error, instead of repeating the error every second.

Remonstrate answered 8/4, 2009 at 14:20 Comment(0)
P
20

The very difference is in their purposes.

setInterval()
   -> executes a function, over and over again, at specified time intervals  

setTimeout()
   -> executes a function, once, after waiting a specified number of milliseconds

It's as simple as that

More elaborate details here http://javascript.info/tutorial/settimeout-setinterval

Pounce answered 11/1, 2014 at 10:16 Comment(1)
Nice concise explanation but note that the OP understands the basic difference in the examples the OP provided. In particular, note that in the OP's setTimeout() example, setTimeout() is called recursively, whereas setInterval() is not.Tented
T
16

When you run some function inside setInterval, which works more time than timeout-> the browser will be stuck.

- E.g., doStuff() takes 1500 sec. to be execute and you do: setInterval(doStuff, 1000);
1) Browser run doStuff() which takes 1.5 sec. to be executed;
2) After ~1 second it tries to run doStuff() again. But previous doStuff() is still executed-> so browser adds this run to the queue (to run after first is done).
3,4,..) The same adding to the queue of execution for next iterations, but doStuff() from previous are still in progress...
As the result- the browser is stuck.

To prevent this behavior, the best way is to run setTimeout inside setTimeout to emulate setInterval.
To correct timeouts between setTimeout calls, you can use self-correcting alternative to JavaScript's setInterval technique.

Totally answered 26/4, 2014 at 17:42 Comment(1)
I don't know why nobody has found any value in this answer!Myrtismyrtle
S
10

Your code will have different execution intevals, and in some projects, such as online games it's not acceptable. First, what should you do, to make your code work with same intevals, you should change "myTimeoutFunction" to this:

function myTimeoutFunction()
{
    setTimeout(myTimeoutFunction, 1000);
    doStuff();
}
myTimeoutFunction()

After this change, it will be equal to

function myTimeoutFunction()
{
    doStuff();
}
myTimeoutFunction();
setInterval(myTimeoutFunction, 1000);

But, you will still have not stable result, because JS is single-threaded. For now, if JS thread will be busy with something, it will not be able to execute your callback function, and execution will be postponed for 2-3 msec. Is you have 60 executions per second, and each time you have random 1-3 sec delay, it will be absolutely not acceptable (after one minute it will be around 7200 msec delay), and I can advice to use something like this:

    function Timer(clb, timeout) {
        this.clb = clb;
        this.timeout = timeout;
        this.stopTimeout = null;
        this.precision = -1;
    }

    Timer.prototype.start = function() {
        var me = this;
        var now = new Date();
        if(me.precision === -1) {
            me.precision = now.getTime();
        }
        me.stopTimeout = setTimeout(function(){
            me.start()
        }, me.precision - now.getTime() + me.timeout);
        me.precision += me.timeout;
        me.clb();
    };

    Timer.prototype.stop = function() {
        clearTimeout(this.stopTimeout);
        this.precision = -1;
    };

    function myTimeoutFunction()
    {
        doStuff();
    }

    var timer = new Timer(myTimeoutFunction, 1000);
    timer.start();

This code will guarantee stable execution period. Even thread will be busy, and your code will be executed after 1005 mseconds, next time it will have timeout for 995 msec, and result will be stable.

Stagecraft answered 24/12, 2016 at 11:32 Comment(0)
G
9

I use setTimeout.

Apparently the difference is setTimeout calls the method once, setInterval calls it repeatdly.

Here is a good article explaining the difference: Tutorial: JavaScript timers with setTimeout and setInterval

Grime answered 8/4, 2009 at 13:15 Comment(2)
Yep, I got that difference, but the two pieces of code I've provided should then do the same thing...Bailment
Ummm yes... I would have thought... but according to dcaunt and his vote count that's not quite what happens.Grime
L
7

I've made simple test of setInterval(func, milisec), because I was curious what happens when function time consumption is greater than interval duration.

setInterval will generally schedule next iteration just after the start of the previous iteration, unless the function is still ongoing. If so, setInterval will wait, till the function ends. As soon as it happens, the function is immediately fired again - there is no waiting for next iteration according to schedule (as it would be under conditions without time exceeded function). There is also no situation with parallel iterations running.

I've tested this on Chrome v23. I hope it is deterministic implementation across all modern browsers.

window.setInterval(function(start) {
    console.log('fired: ' + (new Date().getTime() - start));
    wait();
  }, 1000, new Date().getTime());

Console output:

fired: 1000    + ~2500 ajax call -.
fired: 3522    <------------------'
fired: 6032
fired: 8540
fired: 11048

The wait function is just a thread blocking helper - synchronous ajax call which takes exactly 2500 milliseconds of processing at the server side:

function wait() {
    $.ajax({
        url: "...",
        async: false
    });
}
Loricate answered 25/11, 2012 at 22:20 Comment(3)
"no situation with parallel iterations running" - yes, this should be impossible. Client-side JavaScript has a single threaded execution model so nothing (event handlers, etc.) ever happens at the same time. Which is why nothing happens (and the browser is unresponsive) during the synchronous ajax call.Basidiospore
Is the browser responsive in the few ms between "intervals"? Would another event fire if it's pending? (Thanks for the tests btw +1)Basidiospore
According to MDN, it is considered "dangerous usage" if the function could execute for longer than the interval time. A recursive setTimout call is preferred.Basidiospore
L
6

Both setInterval and setTimeout return a timer id that you can use to cancel the execution, that is, before the timeouts are triggered. To cancel you call either clearInterval or clearTimeout like this:

var timeoutId = setTimeout(someFunction, 1000);
clearTimeout(timeoutId);
var intervalId = setInterval(someFunction, 1000),
clearInterval(intervalId);

Also, the timeouts are automatically cancelled when you leave the page or close the browser window.

Linettelineup answered 8/4, 2009 at 14:47 Comment(0)
L
6

To look at it a bit differently: setInterval ensures that a code is run at every given interval (i.e. 1000ms, or how much you specify) while setTimeout sets the time that it 'waits until' it runs the code. And since it takes extra milliseconds to run the code, it adds up to 1000ms and thus, setTimeout runs again at inexact times (over 1000ms).

For example, timers/countdowns are not done with setTimeout, they are done with setInterval, to ensure it does not delay and the code runs at the exact given interval.

Lorrin answered 27/1, 2015 at 20:25 Comment(0)
C
4

You can validate bobince answer by yourself when you run the following javascript or check this JSFiddle

<div id="timeout"></div>
<div id="interval"></div>

var timeout = 0;
var interval = 0;

function doTimeout(){
    $('#timeout').html(timeout);
    timeout++;
    setTimeout(doTimeout, 1);
}

function doInterval(){
    $('#interval').html(interval);
    interval++;
}

$(function(){
    doTimeout();
    doInterval();
    setInterval(doInterval, 1);
});
Cultivar answered 17/11, 2014 at 21:45 Comment(0)
O
3

Well, setTimeout is better in one situation, as I have just learned. I always use setInterval, which i have left to run in the background for more than half an hour. When i switched back to that tab, the slideshow (on which the code was used) was changing very rapidly, instead of every 5 seconds that it should have. It does in fact happen again as i test it more and whether it's the browser's fault or not isn't important, because with setTimeout that situation is completely impossible.

Olympe answered 18/10, 2011 at 16:48 Comment(1)
Sounds as though you called setInterval inside the function that you were calling. That's how you loop with setTimeout, but with setInterval you're actually creating an entirely new loop each time it's called.Tallith
J
2

The difference is obvious in console:

enter image description here

Jermaine answered 4/1, 2014 at 21:2 Comment(0)
G
2

Just adding onto what has already been said but the setTimeout version of the code will also reach the Maximum call stack size which will stop it from functioning. Since there is no base case for the recursive function to stop at so you can't have it run forever.

Guesstimate answered 26/5, 2014 at 15:43 Comment(1)
I don't think this is true. See here #8059112Miyokomizar
S
1

If you set the interval in setInterval too short, it may fire before the previous call to the function has been completed. I ran into this problem with a recent browser (Firefox 78). It resulted in the garbage collection not being able to free memory fast enough and built up a huge memory leak. Using setTimeout(function, 500); gave the garbage collection enough time to clean up and keep the memory stable over time.

Serg Hospodarets mentioned the problem in his answer and I fully agree with his remarks, but he didn't include the memory leak/garbage collection-problem. I experienced some freezing, too, but the memory usage ran up to 4 GB in no time for some minuscule task, which was the real bummer for me. Thus, I think this answer is still beneficial to others in my situation. I would have put it in a comment, but lack the reputation to do so. I hope you don't mind.

Symons answered 6/7, 2020 at 10:54 Comment(0)
S
0

The reason why Option A and Option B seem like they work the same is mostly because the places of the setInterval and the setTimeout functions.

function myTimeoutFunction()
{
    doStuff();
    setTimeout(myTimeoutFunction, 1000);
}

myTimeoutFunction();

This one is a recursive function, and if doStuff is very complex, setTimeout has to keep track of all calls of the setTimout plus the current doStuff, which makes it become slower and s l o w e r.

function myTimeoutFunction()
{
    doStuff();
}

myTimeoutFunction();
setInterval(myTimeoutFunction, 1000);

On the other hand, the setInterval only has to keep track of the last setInterval and the current doStuff, making it staying at a constant speed.

So which one should you use?

From the above, you should probably be able to conclude that the better one is setInterval.

Scheffler answered 11/3, 2021 at 17:6 Comment(0)
R
0

The important point to consider is the performance. The only way to run a function periodically using setTimeout is to call it recursively with the target function, and when you check it, it appears that it works asynchronously put when you see the call stack you will find it keep growing by the time. In fact, it is sensible. Since Javascript does not support multi-threading, it is impossible to finish calling the parent function before finishing the child function, therefor, the stack will keep growing as long as there is recursive calling. Whilst, with setInterval we don't need to call the target function recursively since it has a logic that runs it periodically as a loop. So, this keeps the call stack clean. You can watch the call stack using developer's tools in your browser and you will notice the difference.

The difference will be clear when using small interval for a long period of time.

Ripe answered 22/12, 2021 at 16:8 Comment(0)

© 2022 - 2024 — McMap. All rights reserved.