current community

more stack exchange communities

Stack Exchange
tour help
careers 2.0
Take the 2-minute tour ×
Stack Overflow is a question and answer site for professional and enthusiast programmers. It's 100% free, no registration required.
up vote 547 down vote favorite
132

How do I check if a particular key exists in a JavaScript object or array?

If a key doesn't exist and I try to access it, will it return false? Or throw an error?

share|improve this question
10  
Actually JavaScript does not support associative arrays: andrewdupont.net/2006/05/18/… It's a common mistake but you will not find any reference to associative arrays in the official JavaScript documentation (and there's not a single array-method in JavaScript that will do anything productive with associative arrays). Associative arrays might seem to work just fine, but just try including e.g. prototype.js in your script and you'll find yourself in quite a mess (trust me, I found out the hard way ;-). Easy solution: use Object instead –  st. m May 9 '11 at 15:03
7  
Minor nitpick, but the JavaScript associative array is actually an object. The JavaScript array can only have non-negative numbers for its index. There is a difference in how objects are declared, but you can access object properties with the square-bracket-string-key syntax, exactly like associative arrays in other languages (PHP e.g.). As st. m points out in the answer below, when you do var myArray = []; myArray['one'] = foo; you're actually setting an object property on the variable, which can cause quite a bit of confusion. –  Patrick M Jul 24 '12 at 7:20
1  
Everything (almost everything) in JavaScript is an Object or can be cast as one. This is where pseudo associative arrays are born just like @PatrickM pointed out. –  Andrew Larsson Jan 3 '13 at 18:50
1  
Ah, semantics :] –  fettereddingoskidney Apr 12 '13 at 17:56
add comment

4 Answers

up vote 801 down vote accepted

Actually, checking for undefined-ness is not an accurate way of testing whether a key exists. What if the key exists but the value is actually undefined?

var obj = { key: undefined };
obj["key"] != undefined // false, but the key exists!

You should instead use the in operator:

"key" in obj // true, regardless of the actual value

If you want to check if a key doesn't exist, remember to use parenthesis:

!("key" in obj) // true if "key" doesn't exist in object
!"key" in obj   // ERROR!  Equivalent to "false in obj"

Or, if you want to particularly test for properties of the object instance (and not inherited properties), use hasOwnProperty:

obj.hasOwnProperty("key") // true
share|improve this answer
16  
Having a property with a manually defined value of undefined makes absolutely no sense. It would be an oxymoron really. –  joebert Jul 8 '09 at 15:57
58  
I'm convinced that there are use cases for having properties intentionally set to undefined. –  Ates Goral Jul 8 '09 at 16:12
65  
Valid use case: Gecko 1.9.1 [Firefox 3.5] has no window.onhashchange property. Gecko 1.9.2 [Firefox 3.6] has this property set to undefined (until the hash changes). To feature detect the hash history or the browser version, one must use window.hasOwnProperty("onhashchange"); –  SamGoody Feb 12 '10 at 10:45
2  
A similar problem exists in PHP where null==nonexistent : stackoverflow.com/q/418066/372654 and unfortunately, null has a use there too. –  Halil Özgür Jan 8 '12 at 21:37
2  
@joebert Just because something is nonsense doesn't mean you won't encounter it in production code. There are many libraries which do nonsensical things. –  Crashworks Jan 10 at 2:57
show 2 more comments
up vote 47 down vote

It will return undefined.

var aa = {hello: "world"};
alert( aa["hello"] );      // popup box with "world"
alert( aa["goodbye"] );    // popup boc with "undefined"

undefined is a special constant value. So you can say, e.g.

// note the three equal signs so that null won't be equal to undefined
if( aa["goodbye"] === undefined ) {
    // do something
}

This is probably the best way to check for missing keys. However, as is pointed out in a comment below, it's theoretically possible that you'd want to have the actual value be undefined. I've never needed to do this and can't think of a reason offhand why I'd ever want to, but just for the sake of completeness, you can use the in operator

// this works even if you have {"goodbye": undefined}
if( "goodbye" in aa ) {
    // do something
}
share|improve this answer
 
Yes. It returns undefined whether it is created as an object or an array. –  Nosredna Jul 8 '09 at 13:30
5  
What if the key exists but the value is actually undefined? –  Ates Goral Jul 8 '09 at 15:52
7  
You should use === instead of == when comparing to undefined, otherwise null will compare equal to undefined. –  Matthew Crumley Jul 8 '09 at 15:56
 
@Matthew: thanks for the tip; I've edited my response to change == to ===. –  Eli Courtwright Jul 8 '09 at 17:36
4  
Eli your answer is not completely accurate. Because anyway (and of course this should not ever be done) undefined is not a special constant value. In fact, it's not a reserved keyword and you can overwrite it, let's say for example, that var undefined = 42;. When testing for undefined props you should always use ((typeof variable) === "undefined"). –  ssice Dec 4 '11 at 13:00
show 5 more comments
up vote 7 down vote 
"key" in obj

Is likely testing only object attribute values that are very different from array keys

share|improve this answer
1  
Definitely a good thing to double check, but I did, and the 'in' operator is checking for property names (objects) or indexes (arrays): developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/… –  TwainJ Nov 5 '13 at 22:57
add comment
up vote 0 down vote

Three ways to check if a property is present in a javascript object:

  1. !!obj.theProperty
    Will convert value to bool. returns TRUE for all but the 'false' value
  2. 'theProperty' in obj
    Will return true if the property exists, no matter its value (even empty)
  3. obj.hasOwnProperty('theProperty')
    Does not check the prototype chain. (since all objects have the 'toString' method, 1 and 2 will return true on it, while 3 can return false on it.)

Reference: http://book.mixu.net/node/ch5.html

share|improve this answer
add comment

protected by Mohammad Adil Dec 5 '13 at 20:21

This question is protected to prevent "thanks!", "me too!", or spam answers by new users. To answer it, you must have earned at least 10 reputation on this site.

Not the answer you're looking for? Browse other questions tagged or ask your own question.