Elements order in a "for (… in …)" loop
Asked Answered
P

10

228

Does the "for…in" loop in Javascript loop through the hashtables/elements in the order they are declared? Is there a browser which doesn't do it in order?
The object I wish to use will be declared once and will never be modified.

Suppose I have:

var myObject = { A: "Hello", B: "World" };

And I further use them in:

for (var item in myObject) alert(item + " : " + myObject[item]);

Can I expect 'A : "Hello"' to always come before 'B : "World"' in most decent browsers?

Pals answered 11/11, 2008 at 12:0 Comment(5)
Becasue they would only be testing a subset of potential browsers and variants. Not to mention any future browsers. It is plain wrong to assume a non-failing test provides any sort of concrete proof.Macneil
I doubt my own limited javascript ability will be better than the SO crowd. Besides who knows what strange browser lurks out there? And you can see in the answer that GChrome does have a bug which will not be apparent in my simple example case.Pals
possible duplicate of Does JavaScript Guarantee Object Property Order?Leverrier
also relevant: Does ES6 introduce a well-defined order of enumeration for object properties?Leverrier
Does this answer your question? Does ES6 introduce a well-defined order of enumeration for object properties?Monticule
A
233

Quoting John Resig:

Currently all major browsers loop over the properties of an object in the order in which they were defined. Chrome does this as well, except for a couple cases. [...] This behavior is explicitly left undefined by the ECMAScript specification. In ECMA-262, section 12.6.4:

The mechanics of enumerating the properties ... is implementation dependent.

However, specification is quite different from implementation. All modern implementations of ECMAScript iterate through object properties in the order in which they were defined. Because of this the Chrome team has deemed this to be a bug and will be fixing it.

All browsers respect definition order with the exception of Chrome and Opera which do for every non-numerical property name. In these two browsers the properties are pulled in-order ahead of the first non-numerical property (this is has to do with how they implement arrays). The order is the same for Object.keys as well.

This example should make it clear what happens:

var obj = {
  "first":"first",
  "2":"2",
  "34":"34",
  "1":"1",
  "second":"second"
};
for (var i in obj) { console.log(i); };
// Order listed:
// "1"
// "2"
// "34"
// "first"
// "second"

The technicalities of this are less important than the fact that this may change at any time. Do not rely on things staying this way.

In short: Use an array if order is important to you.

Arterial answered 11/11, 2008 at 13:24 Comment(10)
Not really. Chrome doesn't implement the same order as other browsers: code.google.com/p/v8/issues/detail?id=164Signboard
@Tim, Thanks for the nudge. I've updated the answer to reflect the current state of reality.Arterial
"Use an array if order is important to you": What about when you're using JSON?Despatch
@HM2K, Same thing, spec says "An object is an unordered collection of zero or more name/value pairs." JSON isn't JavaScript: A server doesn't need to (and probably won't) respect the order you hand it.Arterial
Firefox since its 21 version doesn't seem to respect the insertion order anymore.Vaulting
Respecting insertion order for array indices would either mean that arrays (or the particular array being tested) is not backed by a real array or it is backed by a real array and for some reason the insertion order is stored separately. So it is good that is not happening. It is no surprise IE10, Chrome and Firefox all log true here. Properties should be in insertion order because of the usage of shapes/hidden classes.Glycoprotein
This answer is false in ES2015.Fixture
@Arterial Is there any news about this matter in 2019 ?Girlie
@BenjaminGruenbaum Is there any news about this matter in 2019 ?Girlie
@GrégoryNEUT yes but only for some methods, EnumerateObjectProperties and EnumerableOwnPropertyNames order is implementation dependent. Maps iterate with insertion order for example. Object.keys order is still implementation dependent apparently.Fixture
M
54

Bumping this a year later...

It is 2012 and the major browsers still differ:

function lineate(obj){
    var arr = [], i;
    for (i in obj) arr.push([i,obj[i]].join(':'));
    console.log(arr);
}
var obj = { a:1, b:2, c:3, "123":'xyz' };
/* log1 */  lineate(obj);
obj.a = 4;
/* log2 */  lineate(obj);
delete obj.a;
obj.a = 4;
/* log3 */  lineate(obj);

gist or test in current browser

Safari 5, Firefox 14

["a:1", "b:2", "c:3", "123:xyz"]
["a:4", "b:2", "c:3", "123:xyz"]
["b:2", "c:3", "123:xyz", "a:4"]

Chrome 21, Opera 12, Node 0.6, Firefox 27

["123:xyz", "a:1", "b:2", "c:3"]
["123:xyz", "a:4", "b:2", "c:3"]
["123:xyz", "b:2", "c:3", "a:4"]

IE9

[123:xyz,a:1,b:2,c:3] 
[123:xyz,a:4,b:2,c:3] 
[123:xyz,a:4,b:2,c:3] 
Mislay answered 2/1, 2012 at 19:2 Comment(7)
what's the problem here? Exactly as the specification says, it's an unordered list of key/val pairs.Allina
no one said the spec was "wrong"... There exists an annoyingly inconsistant treatment in browser handling programmatic order of access to these "unordered" propsMislay
nickf: the implementations are right in that they do what the spec says. I think everyone agrees that the javascript spec is.. well, I don't want to use the word "wrong", how about "extremely stupid and annoying"? :POvariectomy
@boxed: Think about objects as a hash map (table/whatever). In most languages (Java, Python, etc) these kinds of data structures are not sorted. So it is not surprising that this is the same case in JavaScript as well and it certainly does not make the specification wrong or stupid.Rolling
I honestly don't see the point of this answer (sorry). The order in which properties are iterated over is an implementation detail, and browsers use different JavaScript engines, so it is expected that the order differs. This won't change.Rolling
I know how it works and I know it won't change in any reasonable time. That doesn't change the fact that it sucks :POvariectomy
In a state of art implementation you will receive integer properties in numerical value order due to being backed by a real array, and named properties will be received in insertion order due to hidden classes/shapes formulation. What can vary is whether they list the integer properties first or named properties first. The addition of delete is interesting because at least in V8, it instantly causes the object to be backed up by a hash table. However, the hash table in V8 stores in insertion order. Most interesting result here is IE, I wonder what kind of ugliness they do to pull that off...Glycoprotein
A
29

From the ECMAScript Language Specification, section 12.6.4 (on the for .. in loop):

The mechanics of enumerating the properties is implementation dependent. The order of enumeration is defined by the object.

And section 4.3.3 (definition of "Object"):

It is an unordered collection of properties each of which contains a primitive value, object, or function. A function stored in a property of an object is called a method.

I guess that means you cant rely on the properties being enumerated in a consistent order across JavaScript implementations. (It would be bad style anyway to rely on implementation-specific details of a language.)

If you want your order defined, you will need to implement something that defines it, like an array of keys that you sort before accessing the object with it.

Ammons answered 11/11, 2008 at 12:14 Comment(0)
P
10

The elements of an object that for/in enumerates are the properties that don't have the DontEnum flag set. The ECMAScript, aka Javascript, standard explicitly says that "An Object is an unordered collection of properties" (see http://www.mozilla.org/js/language/E262-3.pdf section 8.6).

It's not going to be standards conformant (i.e. safe) to assume all Javascript implementations will enumerate in declaration order.

Pard answered 11/11, 2008 at 12:14 Comment(1)
which is why he's asking the question, instead of just assuming :pKnurl
W
5

Iteration order is also confused with respect to deleting of properties, but in this case with IE only.

var obj = {};
obj.a = 'a';
obj.b = 'b';
obj.c = 'c';

// IE allows the value to be deleted...
delete obj.b;

// ...but remembers the old position if it is added back later
obj.b = 'bb';
for (var p in obj) {
    alert(obj[p]); // in IE, will be a, bb, then c;
                   // not a, c, then bb as for FF/Chrome/Opera/Safari
}

The desire for changing the spec to fix the iteration order seems to be quite a popular desire among developers if the discussion at http://code.google.com/p/v8/issues/detail?id=164 is any indication.

Worrisome answered 4/1, 2011 at 7:44 Comment(0)
B
3

in IE6, the order is not guaranteed.

Balustrade answered 8/12, 2008 at 19:49 Comment(1)
well, I mean..., it's IE6.Wagonette
R
3

The order cannot be trusted. Both Opera and Chrome return the list of properties unordered.

<script type="text/javascript">
var username = {"14719":"A","648":"B","15185":"C"};

for (var i in username) {
  window.alert(i + ' => ' + username[i]);
}
</script>

The code above shows B, A, C in Opera and C, A, B in Chrome.

Ramsay answered 25/8, 2010 at 14:57 Comment(0)
G
3

As stated by other answers, no, the order is not guaranteed.

If you want to iterate in order, you can do something like:

const sortedKeys = Object.keys(myObject).sort();
for (let key of sortedKeys) {
  let value = myObject[key];
  
  // Do what you want with key and value 
}

Note that performance-wise, this is not optimal, but that's the price when you want a nice alphabetical display.

Galegalea answered 11/8, 2020 at 9:30 Comment(1)
This is the right answer if someone is looking for an implementation of sorting through an object's properties in deterministic order.Cavanagh
R
2

This does not answer the question per se, but offers a solution to the basic problem.

Assuming that you cannot rely on order to preserved, why not use an array of objects with key and value as properties?

var myArray = [
    {
        'key'   : 'key1'
        'value' : 0
    },
    {
        'key'   : 'key2',
        'value' : 1
    } // ...
];

Now, it is up to you to ensure that the keys are unique (assuming that this is also important to you). As well, direct addressing changes, and for (...in...) now returns indices as 'keys'.

> console.log(myArray[0].key);
key1

> for (let index in myArray) {console.log(myArray[index].value);}
0
1
See the Pen for (...in...) addressing in order by JDQ (@JDQ) on CodePen.
Rathbun answered 29/4, 2018 at 22:5 Comment(0)
D
0

As of 2022,

I have just found out (to my surprise), that Chrome does not respect the definition order. It rather sorts it alphabetically but not naturally. For example key "a12" comes BEFORE "a3". So be careful.

Donny answered 31/1, 2022 at 12:21 Comment(0)

© 2022 - 2024 — McMap. All rights reserved.