Why is setTimeout(fn, 0) sometimes useful?
Asked Answered
P

19

1100

I've recently run into a rather nasty bug, wherein the code was loading a <select> dynamically via JavaScript. This dynamically loaded <select> had a pre-selected value. In IE6, we already had code to fix the selected <option>, because sometimes the <select>'s selectedIndex value would be out of sync with the selected <option>'s index attribute, as below:

field.selectedIndex = element.index;

However, this code wasn't working. Even though the field's selectedIndex was being set correctly, the wrong index would end up being selected. However, if I stuck an alert() statement in at the right time, the correct option would be selected. Thinking this might be some sort of timing issue, I tried something random that I'd seen in code before:

var wrapFn = (function() {
    var myField = field;
    var myElement = element;

    return function() {
        myField.selectedIndex = myElement.index;
    }
})();
setTimeout(wrapFn, 0);

And this worked!

I've got a solution for my problem, but I'm uneasy that I don't know exactly why this fixes my problem. Does anyone have an official explanation? What browser issue am I avoiding by calling my function "later" using setTimeout()?

Particle answered 22/4, 2009 at 21:46 Comment(5)
Most of the question describe why is it useful. If you need to know why does this happen - read my answer: https://mcmap.net/q/53040/-why-is-settimeout-fn-0-sometimes-usefulDeem
Philip Roberts explains this in the best possible way here in his talk "What the heck is the event loop?" youtube.com/watch?v=8aGhZQkoFbQPectin
If you're in a hurry this is the part of the video he starts to address the question exactly: youtu.be/8aGhZQkoFbQ?t=14m54s. Regarldless, the whole video is worth a watch for sure.Septilateral
setTimeout(fn) is same as setTimeout(fn, 0), btw.Townsman
Relevant to this question is the queueMicrotask() method, which was introduced later.Antevert
T
982

In the question, there existed a race condition between:

  1. The browser's attempt to initialize the drop-down list, ready to have its selected index updated, and
  2. Your code to set the selected index

Your code was consistently winning this race and attempting to set drop-down selection before the browser was ready, meaning that the bug would appear.

This race existed because JavaScript has a single thread of execution that is shared with page rendering. In effect, running JavaScript blocks the updating of the DOM.

Your workaround was:

setTimeout(callback, 0)

Invoking setTimeout with a callback, and zero as the second argument will schedule the callback to be run asynchronously, after the shortest possible delay - which will be around 10ms when the tab has focus and the JavaScript thread of execution is not busy.

The OP's solution, therefore was to delay by about 10ms, the setting of the selected index. This gave the browser an opportunity to initialize the DOM, fixing the bug.

Every version of Internet Explorer exhibited quirky behaviors and this kind of workaround was necessary at times. Alternatively it might have been a genuine bug in the OP's codebase.


See Philip Roberts talk "What the heck is the event loop?" for more thorough explanation.

Tweeze answered 23/4, 2009 at 0:14 Comment(9)
'The solution is to "pause" the JavaScript execution to let the rendering threads catch up.' Not entirely true, what setTimeout does is add a new event to the browser event queue and the rendering engine is already in that queue (not entirely true, but close enough) so it gets executed before the setTimeout event.Atabrine
Yes, that is a much more detailed and much more correct answer. But mine is "correct enough" for people to understand why the trick works.Tweeze
@DavidMulder, does it means browser parse css and rendering in a different thread from javascript execution thread?Isopropyl
Nope, they are parsed in principle in the same thread otherwise a few lines of DOM manipulation would trigger reflows all the time which would have an extremely bad influence on the speed of execution.Atabrine
There are some JS errors in IE8 that seem to ignore try/catch. Don't ask me how this happens - I still can't figure it out. Seems like it's related to low-level components like ActiveX or whatever does gradient filters in ProgressiveIE. There is but one way to ignore those errors - wrap the call in setTimeout with 0 timeout - this way setTimeout callback is essentially run in different thread, and on error that thread gets interrupted, but the one that called setTimeout continues to work. So here's +1 reason to use setTimeout with 0 timeout in IE.Decency
This video is the best explanation to why us setTimeout 0 2014.jsconf.eu/speakers/…Cosmopolite
I just had an SVG problem where I wanted to remove an svg element and then add it and then do a bunch of things. The problem was that these "bunch of things" were being done as the remove/add occured, and wrapping the rest of the function in setTimeout 0 made the "transitions" work again. Very strange.Binal
@Cosmopolite I would also highly suggest this fantastic (and humorous) presentation: youtube.com/watch?v=cCOL7MC4Pl0Crete
You might even consider a timeout of more than 0ms, as suggested in this answer and comment : #58355031Yvor
G
726

Preface:

Some of the other answers are correct but don't actually illustrate what the problem being solved is, so I created this answer to present that detailed illustration.

As such, I am posting a detailed walk-through of what the browser does and how using setTimeout() helps. It looks longish but is actually very simple and straightforward - I just made it very detailed.

UPDATE: I have made a JSFiddle to live-demonstrate the explanation below: http://jsfiddle.net/C2YBE/31/ . Many thanks to @ThangChung for helping to kickstart it.

UPDATE2: Just in case JSFiddle web site dies, or deletes the code, I added the code to this answer at the very end.


DETAILS:

Imagine a web app with a "do something" button and a result div.

The onClick handler for "do something" button calls a function "LongCalc()", which does 2 things:

  1. Makes a very long calculation (say takes 3 min)

  2. Prints the results of calculation into the result div.

Now, your users start testing this, click "do something" button, and the page sits there doing seemingly nothing for 3 minutes, they get restless, click the button again, wait 1 min, nothing happens, click button again...

The problem is obvious - you want a "Status" DIV, which shows what's going on. Let's see how that works.


So you add a "Status" DIV (initially empty), and modify the onclick handler (function LongCalc()) to do 4 things:

  1. Populate the status "Calculating... may take ~3 minutes" into status DIV

  2. Makes a very long calculation (say takes 3 min)

  3. Prints the results of calculation into the result div.

  4. Populate the status "Calculation done" into status DIV

And, you happily give the app to users to re-test.

They come back to you looking very angry. And explain that when they clicked the button, the Status DIV never got updated with "Calculating..." status!!!


You scratch your head, ask around on StackOverflow (or read docs or google), and realize the problem:

The browser places all its "TODO" tasks (both UI tasks and JavaScript commands) resulting from events into a single queue. And unfortunately, re-drawing the "Status" DIV with the new "Calculating..." value is a separate TODO which goes to the end of the queue!

Here's a breakdown of the events during your user's test, contents of the queue after each event:

  • Queue: [Empty]
  • Event: Click the button. Queue after event: [Execute OnClick handler(lines 1-4)]
  • Event: Execute first line in OnClick handler (e.g. change Status DIV value). Queue after event: [Execute OnClick handler(lines 2-4), re-draw Status DIV with new "Calculating" value]. Please note that while the DOM changes happen instantaneously, to re-draw the corresponding DOM element you need a new event, triggered by the DOM change, that went at the end of the queue.
  • PROBLEM!!! PROBLEM!!! Details explained below.
  • Event: Execute second line in handler (calculation). Queue after: [Execute OnClick handler(lines 3-4), re-draw Status DIV with "Calculating" value].
  • Event: Execute 3rd line in handler (populate result DIV). Queue after: [Execute OnClick handler(line 4), re-draw Status DIV with "Calculating" value, re-draw result DIV with result].
  • Event: Execute 4th line in handler (populate status DIV with "DONE"). Queue: [Execute OnClick handler, re-draw Status DIV with "Calculating" value, re-draw result DIV with result; re-draw Status DIV with "DONE" value].
  • Event: execute implied return from onclick handler sub. We take the "Execute OnClick handler" off the queue and start executing next item on the queue.
  • NOTE: Since we already finished the calculation, 3 minutes already passed for the user. The re-draw event didn't happen yet!!!
  • Event: re-draw Status DIV with "Calculating" value. We do the re-draw and take that off the queue.
  • Event: re-draw Result DIV with result value. We do the re-draw and take that off the queue.
  • Event: re-draw Status DIV with "Done" value. We do the re-draw and take that off the queue. Sharp-eyed viewers might even notice "Status DIV with "Calculating" value flashing for fraction of a microsecond - AFTER THE CALCULATION FINISHED

So, the underlying problem is that the re-draw event for "Status" DIV is placed on the queue at the end, AFTER the "execute line 2" event which takes 3 minutes, so the actual re-draw doesn't happen until AFTER the calculation is done.


To the rescue comes the setTimeout(). How does it help? Because by calling long-executing code via setTimeout, you actually create 2 events: setTimeout execution itself, and (due to 0 timeout), separate queue entry for the code being executed.

So, to fix your problem, you modify your onClick handler to be TWO statements (in a new function or just a block within onClick):

  1. Populate the status "Calculating... may take ~3 minutes" into status DIV

  2. Execute setTimeout() with 0 timeout and a call to LongCalc() function.

    LongCalc() function is almost the same as last time but obviously doesn't have "Calculating..." status DIV update as first step; and instead starts the calculation right away.

So, what does the event sequence and the queue look like now?

  • Queue: [Empty]
  • Event: Click the button. Queue after event: [Execute OnClick handler(status update, setTimeout() call)]
  • Event: Execute first line in OnClick handler (e.g. change Status DIV value). Queue after event: [Execute OnClick handler(which is a setTimeout call), re-draw Status DIV with new "Calculating" value].
  • Event: Execute second line in handler (setTimeout call). Queue after: [re-draw Status DIV with "Calculating" value]. The queue has nothing new in it for 0 more seconds.
  • Event: Alarm from the timeout goes off, 0 seconds later. Queue after: [re-draw Status DIV with "Calculating" value, execute LongCalc (lines 1-3)].
  • Event: re-draw Status DIV with "Calculating" value. Queue after: [execute LongCalc (lines 1-3)]. Please note that this re-draw event might actually happen BEFORE the alarm goes off, which works just as well.
  • ...

Hooray! The Status DIV just got updated to "Calculating..." before the calculation started!!!



Below is the sample code from the JSFiddle illustrating these examples: http://jsfiddle.net/C2YBE/31/ :

HTML code:

<table border=1>
    <tr><td><button id='do'>Do long calc - bad status!</button></td>
        <td><div id='status'>Not Calculating yet.</div></td>
    </tr>
    <tr><td><button id='do_ok'>Do long calc - good status!</button></td>
        <td><div id='status_ok'>Not Calculating yet.</div></td>
    </tr>
</table>

JavaScript code: (Executed on onDomReady and may require jQuery 1.9)

function long_running(status_div) {

    var result = 0;
    // Use 1000/700/300 limits in Chrome, 
    //    300/100/100 in IE8, 
    //    1000/500/200 in FireFox
    // I have no idea why identical runtimes fail on diff browsers.
    for (var i = 0; i < 1000; i++) {
        for (var j = 0; j < 700; j++) {
            for (var k = 0; k < 300; k++) {
                result = result + i + j + k;
            }
        }
    }
    $(status_div).text('calculation done');
}

// Assign events to buttons
$('#do').on('click', function () {
    $('#status').text('calculating....');
    long_running('#status');
});

$('#do_ok').on('click', function () {
    $('#status_ok').text('calculating....');
    // This works on IE8. Works in Chrome
    // Does NOT work in FireFox 25 with timeout =0 or =1
    // DOES work in FF if you change timeout from 0 to 500
    window.setTimeout(function (){ long_running('#status_ok') }, 0);
});
Generalist answered 1/1, 2011 at 17:53 Comment(27)
great answer DVK! Here is a gist that illustrates your example gist.github.com/kumikoda/5552511#file-timeout-htmlErgotism
Really cool answer, DVK. Just to make easy to imagine, I have put that code to jsfiddle jsfiddle.net/thangchung/LVAaVCome
@ThangChung - I tried to make a better version (2 buttons, one for each case) in JSFiddle. It works as a demo on Chrome and IE but not on FF for some reason - see jsfiddle.net/C2YBE/31. I asked why FF doesn't work here: #20748091Generalist
FYI: this answer was merged here from #4575440Jessikajessup
Even better to write long_running in coroutine-style and do setTimeout sometimes inside of calculations. Because when you do the calculations, all page hangs.Orator
@Generalist "The browser places all its "TODO" tasks (both UI tasks and JavaScript commands) resulting from events into a single queue". Sir can you please provide the source for this? Imho arent browsers supposed to have different UI ( rendering engine ) and JS threads....no offense intended....just want to learn..Hyperkeratosis
@Hyperkeratosis No, everything happens on one thread. This is the reason a long js calculation can block the UIRidicule
Good answer but the demo doesn't work terribly well on Chrome anymore. I tried it on Chrome 41.0.2272.76 for OS X and Windows. I'd say maybe half the time "calculating..." actually appears.Armhole
@user1334007 - try tweaking the timings.Generalist
I did and that works, but isn't the whole point of this thread that you shouldn't have to rely on timing to get this to work? Shouldn't it work with an argument of 0?Armhole
@user1334007 - #20748091Generalist
@DVK, your post at #20748091 seems to echo my sentiments. You seem to be saying that it never works in FF with timeout 0 (which I agree with) and I'm saying it only works sometimes in Chrome with timeout 0. Am I missing something?Armhole
This answer directly coincides with everything I've learned about browser event loops. But I too am experiencing problems in FF -- even the Fiddle does not work as advertised. Merely changing the timing in the setTimeout is not an acceptable answer, as that will entirely depend on the CPU of the machine running the code. This must have something to do with the way Mozilla has decided to implement their task queue, but I unfortunately cannot find more information about it. Has anyone else come up with a better, cross-browser solution?Workingman
Stop, stop! Totally unclear. What is going on when you explain the first section (contents of the queue after each event)? When all those events, that are placed in the queue, are ACTUALLY executed? For now I see that you only populate the queue with them. But when do they begin execution? How is it possible "NOTE: Since we already finished the calculation, 3 minutes already passed for the user"? When did calculation happen? You only placed events into the queue, no any real execution started from your explanation.Jana
You say "Event: Execute first line in OnClick handler (e.g. change Status DIV value)." and provide the queue after it. Isn't the queue after this supposed to be REMOVED from the queue, thus the queue length to be 1, instead of 2?Outlying
@DVK: That was a really good explanation, but just the one thing that I didn't got. And unfortunately, re-drawing the "Status" DIV with the new "Calculating..." value is a separate TODO which goes to the end of the queue! Why end of the queue??? Why not in start or rather where it's written? Any specific reason for putting it at the end of the queue.?Shepherd
This answer is complete and utter nonsense. It doesn't actually answer the OP's question, is needlessly complex, convoluted and worst of all wrong! JavaScript timers - NEVER - read NEVER EVER fire after 0ms - and especially just because you have passed in 0 to setTimeout(). You also should be able to write your explanation without using jQuery, especially as the value of setTimeout(fn, 0) is nothing whatsoever to do with the DOM.Aestivate
@Aestivate I don't get where you are coming from. Where is he even saying that the timer fires after 0 ms?Benham
@Benham - well there is so much nonsense here it hard to see but: 'Alarm from the timeout goes off, 0 seconds later'.Aestivate
The correct answer to the OPs question is: Passing '0' to setTimeout" is syntactic sugar for "Please call me back ASAP", where ASAP is the last message in the current event queue. This allows the current call stack to unwind and execute the next message in the queue. You could equally write setTimeout(fn,1) or 2,3,4. The reason it is useful is it allows the call stack to unwind and allow the JS engine to process other events. See: developer.mozilla.org/en/docs/Web/JavaScript/…Aestivate
This question makes a lot more sense after watching this: 2014.jsconf.eu/speakers/… Skip to 10:24 if you want to get to the point otherwise just skip and watch the video from the start since the beginning is fairly basicListel
may I know what is the difference between window.setTimeout and setTimout?Figurehead
@Figurehead It's the same function. As setTimeout is a variable of the object window, you can call it without window prefix. Same thing like e.g. console.log, console is a window object and can be used without window prefix.Pipette
As far as I understand re-draw event $('#status').text('calculating....'); is put on queue.Before browser finds chance to execute it , long_running function is executed.When for loop inside that function is completed another re-draw event is put on the queue which is $(status_div).text('calculation done'). So we leave with two re-drawing events which haven't taken from the queue yet.At that point $('#status').text('calculating....') re-draw is done and right after that $(status_div).text('calculation done'); re-draw is done.Professor
If we use setTimeout() with a timeout of 0, we actually give the browser a chance to finish doing some non-JavaScript which stays in the queue.In our case it is the re-draw event $('#status').text('calculating....') .By doing so,before long_running is executed browser changes status div text to calculating. Do I miss something ?Professor
Please update the fiddle to make longer calculations... On new computers it takes just a fraction of second and I can barely see the messageNisus
In the fiddle, why doesn't your first button print "calculating...." when clicked? unlike the second buttonMarseillaise
S
94

Take a look at John Resig's article about How JavaScript Timers Work. When you set a timeout, it actually queues the asynchronous code until the engine executes the current call stack.

Sullen answered 6/12, 2010 at 21:38 Comment(0)
S
29

setTimeout() buys you some time until the DOM elements are loaded, even if is set to 0.

Check this out: setTimeout

Schiedam answered 22/4, 2009 at 21:52 Comment(0)
S
26

Browsers have a process called "main thread", that is responsible for executing some JavaScript tasks, UI updates e.g.: painting, redraw, reflow, etc. JavaScript tasks are queued to a message queue and then are dispatched to the browser's main thread to be executed. When UI updates are generated while the main thread is busy, tasks are added into the message queue.

Samuelson answered 22/4, 2009 at 21:46 Comment(3)
"Every JavaScript execution and UI update tasks are added to the browser event queue system, then those tasks are dispatched to the browser main UI Thread to be performed."....source please?Hyperkeratosis
High Performance JavaScript (Nicholas Zakas, Stoyan Stefanov, Ross Harmes, Julien Lecomte, and Matt Sweeney)Samuelson
Downvote for this add this fn to the end of the queue. Most important is where exactly setTimeout adds this func, end of this loop cycle or very start of next loop cycle.Jana
T
26

There are conflicting upvoted answers here, and without proof there is no way to know whom to believe. Here is proof that @DVK is right and @SalvadorDali is incorrect. The latter claims:

"And here is why: it is not possible to have setTimeout with a time delay of 0 milliseconds. The Minimum value is determined by the browser and it is not 0 milliseconds. Historically browsers sets this minimum to 10 milliseconds, but the HTML5 specs and modern browsers have it set at 4 milliseconds."

The 4ms minimum timeout is irrelevant to what is happening. What really happens is that setTimeout pushes the callback function to the end of the execution queue. If after setTimeout(callback, 0) you have blocking code which takes several seconds to run, the callback will not be executed for several seconds, until the blocking code has finished. Try this code:

function testSettimeout0 () {
    var startTime = new Date().getTime()
    console.log('setting timeout 0 callback at ' +sinceStart())
    setTimeout(function(){
        console.log('in timeout callback at ' +sinceStart())
    }, 0)
    console.log('starting blocking loop at ' +sinceStart())
    while (sinceStart() < 3000) {
        continue
    }
    console.log('blocking loop ended at ' +sinceStart())
    return // functions below
    function sinceStart () {
        return new Date().getTime() - startTime
    } // sinceStart
} // testSettimeout0

Output is:

setting timeout 0 callback at 0
starting blocking loop at 5
blocking loop ended at 3000
in timeout callback at 3033
Torment answered 26/7, 2014 at 0:30 Comment(2)
your answer does not prove a thing. It just shows that on your machine under in a specific situation computer throw you some numbers. To prove something related you need a little bit more than few lines of code and a few numbers.Deem
@SalvadorDali, I believe my proof is clear enough for most people to understand. I think you're feeling defensive and haven't made the effort to understand it. I'll be happy to attempt to clarify it, but I don't know what you're failing to understand. Try running the code on your own machine if you suspect my results.Torment
A
21

Both of these two top-rated answers are wrong. Check out the MDN description on the concurrency model and the event loop, and it should become clear what's going on (that MDN resource is a real gem). And simply using setTimeout can be adding unexpected problems in your code in addition to "solving" this little problem.

What's actually going on here is not that "the browser might not be quite ready yet because concurrency," or something based on "each line is an event that gets added to the back of the queue".

The jsfiddle provided by DVK indeed illustrates a problem, but his explanation for it isn't correct.

What's happening in his code is that he's first attaching an event handler to the click event on the #do button.

Then, when you actually click the button, a message is created referencing the event handler function, which gets added to the message queue. When the event loop reaches this message, it creates a frame on the stack, with the function call to the click event handler in the jsfiddle.

And this is where it gets interesting. We're so used to thinking of Javascript as being asynchronous that we're prone to overlook this tiny fact: Any frame has to be executed, in full, before the next frame can be executed. No concurrency, people.

What does this mean? It means that whenever a function is invoked from the message queue, it blocks the queue until the stack it generates has been emptied. Or, in more general terms, it blocks until the function has returned. And it blocks everything, including DOM rendering operations, scrolling, and whatnot. If you want confirmation, just try to increase the duration of the long running operation in the fiddle (e.g. run the outer loop 10 more times), and you'll notice that while it runs, you cannot scroll the page. If it runs long enough, your browser will ask you if you want to kill the process, because it's making the page unresponsive. The frame is being executed, and the event loop and message queue are stuck until it finishes.

So why this side-effect of the text not updating? Because while you have changed the value of the element in the DOM — you can console.log() its value immediately after changing it and see that it has been changed (which shows why DVK's explanation isn't correct) — the browser is waiting for the stack to deplete (the on handler function to return) and thus the message to finish, so that it can eventually get around to executing the message that has been added by the runtime as a reaction to our mutation operation, and in order to reflect that mutation in the UI.

This is because we are actually waiting for code to finish running. We haven't said "someone fetch this and then call this function with the results, thanks, and now I'm done so imma return, do whatever now," like we usually do with our event-based asynchronous Javascript. We enter a click event handler function, we update a DOM element, we call another function, the other function works for a long time and then returns, we then update the same DOM element, and then we return from the initial function, effectively emptying the stack. And then the browser can get to the next message in the queue, which might very well be a message generated by us by triggering some internal "on-DOM-mutation" type event.

The browser UI cannot (or chooses not to) update the UI until the currently executing frame has completed (the function has returned). Personally, I think this is rather by design than restriction.

Why does the setTimeout thing work then? It does so, because it effectively removes the call to the long-running function from its own frame, scheduling it to be executed later in the window context, so that it itself can return immediately and allow the message queue to process other messages. And the idea is that the UI "on update" message that has been triggered by us in Javascript when changing the text in the DOM is now ahead of the message queued for the long-running function, so that the UI update happens before we block for a long time.

Note that a) The long-running function still blocks everything when it runs, and b) you're not guaranteed that the UI update is actually ahead of it in the message queue. On my June 2018 Chrome browser, a value of 0 does not "fix" the problem the fiddle demonstrates — 10 does. I'm actually a bit stifled by this, because it seems logical to me that the UI update message should be queued up before it, since its trigger is executed before scheduling the long-running function to be run "later". But perhaps there're some optimisations in the V8 engine that may interfere, or maybe my understanding is just lacking.

Okay, so what's the problem with using setTimeout, and what's a better solution for this particular case?

First off, the problem with using setTimeout on any event handler like this, to try to alleviate another problem, is prone to mess with other code. Here's a real-life example from my work:

A colleague, in a mis-informed understanding on the event loop, tried to "thread" Javascript by having some template rendering code use setTimeout 0 for its rendering. He's no longer here to ask, but I can presume that perhaps he inserted timers to gauge the rendering speed (which would be the return immediacy of functions) and found that using this approach would make for blisteringly fast responses from that function.

First problem is obvious; you cannot thread javascript, so you win nothing here while you add obfuscation. Secondly, you have now effectively detached the rendering of a template from the stack of possible event listeners that might expect that very template to have been rendered, while it may very well not have been. The actual behaviour of that function was now non-deterministic, as was — unknowingly so — any function that would run it, or depend on it. You can make educated guesses, but you cannot properly code for its behaviour.

The "fix" when writing a new event handler that depended on its logic was to also use setTimeout 0. But, that's not a fix, it is hard to understand, and it is no fun to debug errors that are caused by code like this. Sometimes there's no problem ever, other times it concistently fails, and then again, sometimes it works and breaks sporadically, depending on the current performance of the platform and whatever else happens to going on at the time. This is why I personally would advise against using this hack (it is a hack, and we should all know that it is), unless you really know what you're doing and what the consequences are.

But what can we do instead? Well, as the referenced MDN article suggests, either split the work into multiple messages (if you can) so that other messages that are queued up may be interleaved with your work and executed while it runs, or use a web worker, which can run in tandem with your page and return results when done with its calculations.

Oh, and if you're thinking, "Well, couldn't I just put a callback in the long-running function to make it asynchronous?," then no. The callback doesn't make it asynchronous, it'll still have to run the long-running code before explicitly calling your callback.

Absenteeism answered 5/6, 2018 at 6:26 Comment(3)
Seemingly the only valid and complete comment on this entire pageAlcatraz
Very well explained, thank you!Sabir
From my understanding, this does not apply to operations performed by other browser components, such as network requests, DOM rendering, or filesystem access, right? That is, stuff that will actually be run by another thread, unrelated to Javascript execution.Lettering
E
21

If you don't want to watch a whole video, here's a simple explanation of the things one needs to understand, in order to be able to understand the answer to this question:

  1. JavaScript is single-threaded meaning it does only one thing at a time when running.
  2. But the environments in which the JavaScript is running, can be multi-threaded. E.g., browsers are often multi-threaded creatures, i.e., are able to do multiple things at a time. So they can run JavaScript and at the same time keep track of dealing with other stuff too.

From this point on, we're talking about JavaScript "in browsers". Things like setTimeout are indeed browser things, and are not part of the JavaScript itself.

  1. The thing that allows JavaScript to run asynchronously is the multi-threaded browser! Other than the main space Javascript uses (called the the call stack) to put each line of code on and run them one by one, browsers also provide JavaScript with another space to put things on.

Now let's call that other space the second space.

  1. Let's assume fn is a function. The important thing to understand here is that fn(); call is not equal to the setTimeout(fn, 0); call as will be explained further below.

Instead of a 0 delay, let's assume another delay first, e.g., 5000 milliseconds: setTimeout(fn, 5000);. It's important to note that this is still a "function call", so it has to be put on the main space, and removed from it when it's done, but wait!, we don't like a whole lengthy and boring 5 seconds delay. That would block the main space and will not allow JavaScript to run ANYTHING else in the meantime.

Thankfully this is not how the browser designers designed them to work. Instead, this call(setTimeout(fn, 5000);) is done instantly. This is very important: Even with the 5000 milliseconds delay, this function call is complete in an instant! What will happen next? It gets removed from the main space. Where will it be put on? (because we don't want to lose it). You might have guessed right: The browser hears this call and puts it on the second space. enter image description here

The browser keeps track of the 5 seconds delay and once it's passed, it looks at the main space, and "WHEN IT'S EMPTY", puts the fn(); call back on it. That is how the setTimeout works.

So, back to the setTimeout(fn, 0), even though the delay is zero, this is still a call to the browser, and the browser hears it instantly and picks it up, and puts it on the second space and puts it back on the main space only when the main space is empty again, and not really 0 milliseconds later.

I really recommend watching that video as well since he's explained it really well, and opens technical things up more.

Etsukoetta answered 23/5, 2021 at 7:29 Comment(1)
html.spec.whatwg.org/multipage/…Rockey
B
19

One reason to do that is to defer the execution of code to a separate, subsequent event loop. When responding to a browser event of some kind (mouse click, for example), sometimes it's necessary to perform operations only after the current event is processed. The setTimeout() facility is the simplest way to do it.

edit now that it's 2015 I should note that there's also requestAnimationFrame(), which isn't exactly the same but it's sufficiently close to setTimeout(fn, 0) that it's worth mentioning.

edit again now that it's 2024 I should note that there are things you can do with the Promise API, such as:

Promise.resolve().then(function() {
  // your code here
});

or, fancier:

queueMicrotask(function() {
  // your code here
});

That's not always appropriate, but it is sometimes. Personally I think that designing around subtle differences in the way timers interact is a pretty fragile thing to do. You might have to in some weird situations, but I'd say pick one you like and stick to it.

Balalaika answered 1/1, 2011 at 17:38 Comment(5)
This is precisely one of the places where I've seen it being used. =)Renata
FYI: this answer was merged here from #4575440Jessikajessup
is to defer the execution of code to a separate, subsequent event loop: how do you figure out a subsequent event loop? How do you figure out what is a current event loop? How do you know in what event loop turn you are now?Jana
@Jana well, you don't, really; there's really no direct visibility into what the JavaScript runtime is up to.Balalaika
requestAnimationFrame solved the problem I was having with IE and Firefox not updating UI sometimesDurwin
D
13

This is an old questions with old answers. I wanted to add a new look at this problem and to answer why is this happens and not why is this useful.

So you have two functions:

var f1 = function () {    
   setTimeout(function(){
      console.log("f1", "First function call...");
   }, 0);
};

var f2 = function () {
    console.log("f2", "Second call...");
};

and then call them in the following order f1(); f2(); just to see that the second one executed first.

And here is why: it is not possible to have setTimeout with a time delay of 0 milliseconds. The Minimum value is determined by the browser and it is not 0 milliseconds. Historically browsers sets this minimum to 10 milliseconds, but the HTML5 specs and modern browsers have it set at 4 milliseconds.

If nesting level is greater than 5, and timeout is less than 4, then increase timeout to 4.

Also from mozilla:

To implement a 0 ms timeout in a modern browser, you can use window.postMessage() as described here.

P.S. information is taken after reading the following article.

Deem answered 19/5, 2014 at 21:34 Comment(5)
@user2407309 Are you kidding? you mean that the HTML5 specification is wrong and you are correct? Read the sources before you downvote and make strong claims. My answer is based on HTML specification, and historical record. Instead of doing the answer which explains completely the same stuff again and again, I added something new, something that was not shown in previous answers. I am not telling that this is the only reason, I am just showing something new.Deem
This is incorrect: "And here is why: it is not possible to have setTimeout with a time delay of 0 milliseconds." That is not why. The 4ms delay is irrelevant to why setTimeout(fn,0) is useful.Torment
@user2407309 it can be easily modified to "to add to the reasons stated by others, it is not possible ....". So it is ridiculous to downvote just because of this especially if you own answer is not telling anything new. Just a small edit would be suffice.Deem
Salvador Dali: If you ignore the emotional aspects of the micro flame war here, you'd probably have to admit that @VladimirKornea is right. It is true that browsers map a 0ms delay to 4ms, but even if they didn't, the results would still be the same. The driving mechanism here is that code is pushed onto the queue, rather than the call stack. Have a look at this excellent JSConf presentation, it may help to clarify the issue: youtube.com/watch?v=8aGhZQkoFbQSiena
I'm confused as to why you think your quote on a qualified minimum of 4 ms is a global minimum of 4 ms. As your quote from the HTML5 spec shows, the minimum is 4 ms only when you've nested calls to setTimeout/setInterval more than five levels deep; if you haven't, the minimum is 0 ms (what with lacking time machines). Mozilla's docs expand that to cover repeated, not just nested cases (so setInterval with interval of 0 will reschedule immediately a few times, then delay longer after that), but simple uses of setTimeout with minimal nesting are allowed to immediately queue.Bugeye
F
8

Since it is being passed a duration of 0, I suppose it is in order to remove the code passed to the setTimeout from the flow of execution. So if it's a function that could take a while, it won't prevent the subsequent code from executing.

Fairtrade answered 1/1, 2011 at 17:39 Comment(1)
FYI: this answer was merged here from #4575440Jessikajessup
I
3

The other thing this does is push the function invocation to the bottom of the stack, preventing a stack overflow if you are recursively calling a function. This has the effect of a while loop but lets the JavaScript engine fire other asynchronous timers.

Inelegancy answered 21/6, 2012 at 1:14 Comment(1)
Downvote for this push the function invocation to the bottom of the stack. What stack are you talking about is obscure. Most important is where exactly setTimeout adds this func, end of this loop cycle or very start of next loop cycle.Jana
G
2

By calling setTimeout you give the page time to react to the whatever the user is doing. This is particularly helpful for functions run during page load.

Gish answered 22/4, 2009 at 21:53 Comment(0)
B
2

Some other cases where setTimeout is useful:

You want to break a long-running loop or calculation into smaller components so that the browser doesn't appear to 'freeze' or say "Script on page is busy".

You want to disable a form submit button when clicked, but if you disable the button in the onClick handler the form will not be submitted. setTimeout with a time of zero does the trick, allowing the event to end, the form to begin submitting, then your button can be disabled.

Brisbane answered 14/12, 2012 at 13:9 Comment(2)
Disabling would be better done in the onsubmit event; it would be faster and is guaranteed to be called before the form is technically submitted since you can stop the submission.Camise
Very true. I suppose onclick disabling is easier for prototyping because you can simply type onclick="this.disabled=true" in the button whereas disabling on submit requires slightly more work.Brisbane
C
2

The problem was you were trying to perform a Javascript operation on a non existing element. The element was yet to be loaded and setTimeout() gives more time for an element to load in the following ways:

  1. setTimeout() causes the event to be ansynchronous therefore being executed after all the synchronous code, giving your element more time to load. Asynchronous callbacks like the callback in setTimeout() are placed in the event queue and put on the stack by the event loop after the stack of synchronous code is empty.
  2. The value 0 for ms as a second argument in function setTimeout() is often slightly higher (4-10ms depending on browser). This slightly higher time needed for executing the setTimeout() callbacks is caused by the amount of 'ticks' (where a tick is pushing a callback on the stack if stack is empty) of the event loop. Because of performance and battery life reasons the amount of ticks in the event loop are restricted to a certain amount less than 1000 times per second.
Coelho answered 15/9, 2018 at 9:12 Comment(0)
G
1

The answers about execution loops and rendering the DOM before some other code completes are correct. Zero second timeouts in JavaScript help make the code pseudo-multithreaded, even though it is not.

I want to add that the BEST value for a cross browser / cross platform zero-second timeout in JavaScript is actually about 20 milliseconds instead of 0 (zero), because many mobile browsers can't register timeouts smaller than 20 milliseconds due to clock limitations on AMD chips.

Also, long-running processes that do not involve DOM manipulation should be sent to Web Workers now, as they provide true multithreaded execution of JavaScript.

Glassblowing answered 13/3, 2013 at 23:29 Comment(2)
I am a little skeptical about your answer, but upvoted it because it forced me to do some additional research on browser standards. When researching standards, I go to where I always go, MDN: developer.mozilla.org/en-US/docs/Web/API/window.setTimeout HTML5 spec says 4ms. It doesn't say anything about clock limitations on mobile chips. Having a hard time googling for a source of info to back up your statements. Did find out Dart Language by Google removed setTimeout altogether in favor of a Timer object.Bremser
(...) because many mobile browsers can't register timeouts smaller than 20 milliseconds due to clock limitations (...) Every platform has timing limitations due to its clock and no platform is capable of executing the next thing exactly 0ms after the current one. Timeout of 0ms asks for execution of a function as soon as possible and timing limitations of specific platform does not change the meaning of this in any way.Lineolate
M
1

setTimout on 0 is also very useful in the pattern of setting up a deferred promise, which you want to return right away:

myObject.prototype.myMethodDeferred = function() {
    var deferredObject = $.Deferred();
    var that = this;  // Because setTimeout won't work right with this
    setTimeout(function() { 
        return myMethodActualWork.call(that, deferredObject);
    }, 0);
    return deferredObject.promise();
}
Manama answered 2/9, 2015 at 15:39 Comment(0)
M
0

//When need "new a", setTimeout(fn, 0) is useful, when need to wait some action. Example:

var a = function (){console.log('a');};
var b = function(){setTimeout(b, 100);}; //wait some action before override this function

//without setTimeout:
console.log('no setTimeout: b.toString():', b.toString());
b();    //"b" is an old function
console.log('no setTieout: a.toString(): ', a.toString());
a();    //and "a" is not overrided

setTimeout(//but with setTimeout(fn, 0):
    function(){
        console.log('After timeout 0, b.toString(): ', b.toString());
        b();    //"b" is a new function
        console.log('After timeout 0, a.toString(): ', a.toString());
        a();    //and "a" is overrided
    },
    0
);

//override var "b", which was been undefined
b = function (){
    a = function(){console.log('new a');};
}
Madea answered 12/7, 2021 at 4:48 Comment(2)
Welcome to Stack Overflow. Code without any explanation are rarely helpful. Stack Overflow is about learning, not providing snippets to blindly copy and paste. Please edit your question and explain how it answers the specific question being asked. See How to Answer.Advantageous
This code is commented, and this comments contains an answer. Before setTimeout, function a() not overrided, after running b(), but after seTimeout, this overridded successfully.Madea
C
-2

Javascript is single threaded application so that don't allow to run function concurrently so to achieve this event loops are use. So exactly what setTimeout(fn, 0) do that its pussed into task quest which is executed when your call stack is empty. I know this explanation is pretty boring, so i recommend you to go through this video this will help you how things work under the hood in browser. Check out this video:- https://www.youtube.com/watch?time_continue=392&v=8aGhZQkoFbQ

Cerebroside answered 22/1, 2018 at 7:27 Comment(0)

© 2022 - 2024 — McMap. All rights reserved.