CODEWITHSUNDEEP
javascriptobjectproperties
Rudd Zwolinski
Rudd Zwolinski

Reputation: 27611

What's the correct way to test for existence of a property on a JavaScript Object?

I have a custom Javascript object that I create with new, and assign properties to based on creation arguments:

function MyObject(argument) {
    if (argument) {
        this.prop = "foo";
    }
}
var objWithProp = new MyObject(true); // objWithProp.prop exists
var objWithoutProp = new MyObject(false); // objWithoutProp.prop does not exist

What's the correct way to test for the existence of the prop property of the objects? I've seen the following ways used, but I'm not sure if any of these ways is the best way:

Specifically, I'm only interested in testing if the property is explicitly defined for this object, not in the prototype chain. In addition, the value will never be set to null or undefined, but it could be something like an empty object or array. However, if you want to include what the correct way is if those could be the case, feel free.

Upvotes: 26

Views: 24391

Answers (3)

voltento
voltento

Reputation: 887

You can check the existence of a variable as follows:

if ( typeof variable === 'undefined' || variable === null ) {
    // Do stuff
}

It's also can be used for properties.

Upvotes: 4

farzad
farzad

Reputation: 8855

If you are looking for a property defined in an object, you can use hasOwnProperty method of the object. like this:

myObject = new MyObject();
// some code
if ( myObject.hasOwnProperty('prop') ) {
    // prop exists
}

but this is only to know if such a property is defined in object itself, but not its parents. so if such property is inherited by the object, you can not test its existence like this.

the other way is to test the property against undefined value. like this:

if ( myObject.prop !== undefined ) {
    // prop exists
}

remember to use the !== operator instead of != because != will not differ between null and undefined, but !== does. so if your object has a property but the value is null, != will not help you. so this test:

if ( myObject.prop ) {
}

might have wrong results if "prop" has a false or null value. but by comparing to undefined with !== operator, you can be sure that null/false values will not confuse you.

Upvotes: 10

Alex Martelli
Alex Martelli

Reputation: 882661

hasOwnProperty is exactly what you're looking for, since you specify "if the property is explicitly defined for this object, not in the prototype chain". Per https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object/hasOwnProperty , "This method can be used to determine whether an object has the specified property as a direct property of that object; unlike the in operator, this method does not check down the object's prototype chain." -- seems to exactly match your requirement!

Upvotes: 35

Related Questions