Why aren't these two bits of JavaScript equivalent?

Question

in jquery 1.4.2, ff 3.6.6:

The following code produces three divs, which write messages to the firebug console as you would expect. However, if you uncomment out the loop and comment out the 3 lines doing it manually, it doesn't work - mousing over any of the divs results in "three" being written to the console.

Why are these two methods any different than each other? In each one you use a selector to find the element and add an event to it.

<head>
<script type="text/javascript" src="/media/js/jquery.js"></script>
<script>

$( document ).ready( function() {

  $("#one").mouseenter(function(){console.log("one")})
  $("#two").mouseenter(function(){console.log("two")})
  $("#three").mouseenter(function(){console.log("three")})

  //  names=['one','two','three'];
  //  for (k in names){
  //    id=names[k]
  //    $("#"+id).mouseenter(function(){console.log(id)})
  //  }
})
</script>
</head>

<body>
  <span id="one">ONE</span>
  <p><span id="two">TWO</span></p>
  <p><span id="three">THREE</span></p>
</body>

Please start with fixing your HTML. You have two unclosed
tags. — Māris Kiseļovs, Jul 20 '10 at 06:24
You should declare your variables unless you want them to be global variables. `var names = ['one', 'two', 'three'];`, `for (var k in names) {`, `var id`. — Matt, Jul 20 '10 at 06:35

score 12 · Accepted Answer · edited May 23 '17 at 12:25

You would be having a very common closure problem in the for in loop.

Variables enclosed in a closure share the same single environment, so by the time the mouseenter callback is called, the loop will have run its course and the id variable will be left pointing to the value of the last element of the names array.

This can be quite a tricky topic, if you are not familiar with how closures work. You may want to check out the following article for a brief introduction:

Mozilla Dev Center: Working with Closures

You could solve this with even more closures, using a function factory:

function makeMouseEnterCallback (id) {  
  return function() {  
    console.log(id);
  };  
}

// ...

var id, k,
    names = ['one','two','three'];

for (k = 0; k < names.length; k++) {
  id = names[k];
  $("#" + id).mouseenter(makeMouseEnterCallback(id));
}

You could also inline the above function factory as follows:

var id, k, 
    names = ['one','two','three'];

for (k = 0; k < names.length; k++) {
  id = names[k];
  $("#" + id).mouseenter((function (p_id) {  
    return function() {  
      console.log(p_id);
    };  
  })(id));
}

Any yet another solution could be as @d.m suggested in another answer, enclosing each iteration in its own scope:

var k, 
    names = ['one','two','three'];

for (k = 0; k < names.length; k++) {
  (function() {
    var id = names[k];
    $("#" + id).mouseenter(function () { console.log(id) });
  })();
}

Although not related to this problem, it is generally recommended to avoid using a for in loop to iterate over the items of an array, as @CMS pointed out in a comment below (Further reading). In addition, explicitly terminating your statements with a semicolon is also considered a good practice in JavaScript.

Good answer (+1) but would be even better if you showed him how to do it in a loop by new-ing up new strings for the IDs. — Bernhard Hofmann, Jul 20 '10 at 06:32
Also, although is not the problem, I'll not ever get tired of recommending to **avoid** the `for-in` statement for "iterate" over array objects. [More info](http://stackoverflow.com/questions/3010840/loop-through-array-in-javascript/3010848#3010848) — Christian C. Salvadó, Jul 20 '10 at 06:32
@Bernhard: Thanks... I'll update my answer with a couple of solutions :) — Daniel Vassallo, Jul 20 '10 at 06:33
Small typos, the function name on the first example, and immediate invocation of the anonymous function of the second are missing. — Christian C. Salvadó, Jul 20 '10 at 07:02

dmedvinsky · Answer 2 · 2010-07-20T06:48:02.950

2

This happens because when the code of the anonymous function function(){console.log(id)} is executed, the value of id is three indeed.

To can use the following trick to enclose the value on each loop iteration into the anonymous callback scope:

names=['one', 'two', 'three'];
for (var k in names) {
    (function() {
        var id = names[k];
        $("#"+id).mouseenter(function(){ console.log(id) });
    })();
}

edited Jul 20 '10 at 06:48

answered Jul 20 '10 at 06:32

dmedvinsky

8,046
3
31
25

2

It will not work, because `id` is undeclared and it will become a property of the global object (`window.id`). You need to bind it to the new variable environment (use `var`!). – Christian C. Salvadó Jul 20 '10 at 06:37
1

: You're welcome. Be aware also that `k` will become global, and that the purpose of the `for-in` statement isn't really to *iterate* over the indexes of array objects, it's purpose is to *enumerate* object properties. – Christian C. Salvadó Jul 20 '10 at 06:43
@CMS, oh, dang, sorry; just awaken, not in this world yet. I know about for-in; personally I'd prefer the `for (var i = names.length - 1; i >= 0; i--)` loop in this case, but as I said already, I just copied the fastmultiplication's code. – dmedvinsky Jul 20 '10 at 06:51
: No problem! Yeah, any *secuential loop*, and if the order of iteration is not important a reverse loop e.g. `var i = names.length; while (i--) {/**/}` is enough. Cheers! – Christian C. Salvadó Jul 20 '10 at 06:56

Why aren't these two bits of JavaScript equivalent?

2 Answers2

Linked