Working with objects
JavaScript is designed on an object-based paradigm. An object is a collection ofproperties, and a property is an association between a name (orkey) and a value. A property's value can be a function, in which case the property is known as amethod.
Objects in JavaScript, just as in many other programming languages, can be compared to objects in real life. In JavaScript, an object is a standalone entity, with properties and type. Compare it with a cup, for example. A cup is an object, with properties. A cup has a color, a design, weight, a material it is made of, etc. The same way, JavaScript objects can have properties, which define their characteristics.
In addition to objects that are predefined in the browser, you can define your own objects. This chapter describes how to use objects, properties, and methods, and how to create your own objects.
Creating new objects
You can create an object using anobject initializer. Alternatively, you can first create a constructor function and then instantiate an object by invoking that function with thenew
operator.
Using object initializers
Object initializers are also calledobject literals. "Object initializer" is consistent with the terminology used by C++.
The syntax for an object using an object initializer is:
const obj = { property1: value1, // property name may be an identifier 2: value2, // or a number "property n": value3, // or a string};
Each property name before colons is an identifier (either a name, a number, or a string literal), and eachvalueN
is an expression whose value is assigned to the property name. The property name can also be an expression; computed keys need to be wrapped in square brackets. Theobject initializer reference contains a more detailed explanation of the syntax.
In this example, the newly created object is assigned to a variableobj
— this is optional. If you do not need to refer to this object elsewhere, you do not need to assign it to a variable. (Note that you may need to wrap the object literal in parentheses if the object appears where a statement is expected, so as not to have the literal be confused with a block statement.)
Object initializers are expressions, and each object initializer results in a new object being created whenever the statement in which it appears is executed. Identical object initializers create distinct objects that do not compare to each other as equal.
The following statement creates an object and assigns it to the variablex
if and only if the expressioncond
is true:
let x;if (cond) { x = { greeting: "hi there" };}
The following example createsmyHonda
with three properties. Note that theengine
property is also an object with its own properties.
const myHonda = { color: "red", wheels: 4, engine: { cylinders: 4, size: 2.2 },};
Objects created with initializers are calledplain objects, because they are instances ofObject
, but not any other object type. Some object types have special initializer syntaxes — for example,array initializers andregex literals.
Using a constructor function
Alternatively, you can create an object with these two steps:
- Define the object type by writing a constructor function. There is a strong convention, with good reason, to use a capital initial letter.
- Create an instance of the object with
new
.
To define an object type, create a function for the object type that specifies its name, properties, and methods. For example, suppose you want to create an object type for cars. You want this type of object to be calledCar
, and you want it to have properties for make, model, and year. To do this, you would write the following function:
function Car(make, model, year) { this.make = make; this.model = model; this.year = year;}
Notice the use ofthis
to assign values to the object's properties based on the values passed to the function.
Now you can create an object calledmyCar
as follows:
const myCar = new Car("Eagle", "Talon TSi", 1993);
This statement createsmyCar
and assigns it the specified values for its properties. Then the value ofmyCar.make
is the string"Eagle"
,myCar.model
is the string"Talon TSi"
,myCar.year
is the integer1993
, and so on. The order of arguments and parameters should be the same.
You can create any number ofCar
objects by calls tonew
. For example,
const randCar = new Car("Nissan", "300ZX", 1992);const kenCar = new Car("Mazda", "Miata", 1990);
An object can have a property that is itself another object. For example, suppose you define an object calledPerson
as follows:
function Person(name, age, sex) { this.name = name; this.age = age; this.sex = sex;}
and then instantiate two newPerson
objects as follows:
const rand = new Person("Rand McKinnon", 33, "M");const ken = new Person("Ken Jones", 39, "M");
Then, you can rewrite the definition ofCar
to include anowner
property that takes aPerson
object, as follows:
function Car(make, model, year, owner) { this.make = make; this.model = model; this.year = year; this.owner = owner;}
To instantiate the new objects, you then use the following:
const car1 = new Car("Eagle", "Talon TSi", 1993, rand);const car2 = new Car("Nissan", "300ZX", 1992, ken);
Notice that instead of passing a literal string or integer value when creating the new objects, the above statements pass the objectsrand
andken
as the arguments for the owners. Then if you want to find out the name of the owner ofcar2
, you can access the following property:
car2.owner.name;
You can always add a property to a previously defined object. For example, the statement
car1.color = "black";
adds a propertycolor
tocar1
, and assigns it a value of"black"
. However, this does not affect any other objects. To add the new property to all objects of the same type, you have to add the property to the definition of theCar
object type.
You can also use theclass
syntax instead of thefunction
syntax to define a constructor function. For more information, see theclass guide.
Using the Object.create() method
Objects can also be created using theObject.create()
method. This method can be very useful, because it allows you to choose theprototype object for the object you want to create, without having to define a constructor function.
// Animal properties and method encapsulationconst Animal = { type: "Invertebrates", // Default value of properties displayType() { // Method which will display type of Animal console.log(this.type); },};// Create new animal type called animal1const animal1 = Object.create(Animal);animal1.displayType(); // Logs: Invertebrates// Create new animal type called fishconst fish = Object.create(Animal);fish.type = "Fishes";fish.displayType(); // Logs: Fishes
Objects and properties
A JavaScript object has properties associated with it. Object properties are basically the same as variables, except that they are associated with objects, notscopes. The properties of an object define the characteristics of the object.
For example, this example creates an object namedmyCar
, with properties namedmake
,model
, andyear
, with their values set to"Ford"
,"Mustang"
, and1969
:
const myCar = { make: "Ford", model: "Mustang", year: 1969,};
Like JavaScript variables, property names are case sensitive. Property names can only be strings or Symbols — all keys areconverted to strings unless they are Symbols.Array indices are, in fact, properties with string keys that contain integers.
Accessing properties
You can access a property of an object by its property name.Property accessors come in two syntaxes:dot notation andbracket notation. For example, you could access the properties of themyCar
object as follows:
// Dot notationmyCar.make = "Ford";myCar.model = "Mustang";myCar.year = 1969;// Bracket notationmyCar["make"] = "Ford";myCar["model"] = "Mustang";myCar["year"] = 1969;
An object property name can be any JavaScript string orsymbol, including an empty string. However, you cannot use dot notation to access a property whose name is not a valid JavaScript identifier. For example, a property name that has a space or a hyphen, that starts with a number, or that is held inside a variable can only be accessed using the bracket notation. This notation is also very useful when property names are to be dynamically determined, i.e., not determinable until runtime. Examples are as follows:
const myObj = {};const str = "myString";const rand = Math.random();const anotherObj = {};// Create additional properties on myObjmyObj.type = "Dot syntax for a key named type";myObj["date created"] = "This key has a space";myObj[str] = "This key is in variable str";myObj[rand] = "A random number is the key here";myObj[anotherObj] = "This key is object anotherObj";myObj[""] = "This key is an empty string";console.log(myObj);// {// type: 'Dot syntax for a key named type',// 'date created': 'This key has a space',// myString: 'This key is in variable str',// '0.6398914448618778': 'A random number is the key here',// '[object Object]': 'This key is object anotherObj',// '': 'This key is an empty string'// }console.log(myObj.myString); // 'This key is in variable str'
In the above code, the keyanotherObj
is an object, which is neither a string nor a symbol. When it is added to themyObj
, JavaScript calls thetoString()
method ofanotherObj
, and use the resulting string as the new key.
You can also access properties with a string value stored in a variable. The variable must be passed in bracket notation. In the example above, the variablestr
held"myString"
and it is"myString"
that is the property name. Therefore,myObj.str
will return as undefined.
str = "myString";myObj[str] = "This key is in variable str";console.log(myObj.str); // undefinedconsole.log(myObj[str]); // 'This key is in variable str'console.log(myObj.myString); // 'This key is in variable str'
This allows accessing any property as determined at runtime:
let propertyName = "make";myCar[propertyName] = "Ford";// access different properties by changing the contents of the variablepropertyName = "model";myCar[propertyName] = "Mustang";console.log(myCar); // { make: 'Ford', model: 'Mustang' }
However, beware of using square brackets to access properties whose names are given by external input. This may make your code susceptible toobject injection attacks.
Nonexistent properties of an object have valueundefined
(and notnull
).
myCar.nonexistentProperty; // undefined
Enumerating properties
There are three native ways to list/traverse object properties:
for...in
loops. This method traverses all of the enumerable string properties of an object as well as its prototype chain.Object.keys()
. This method returns an array with only the enumerable own string property names ("keys") in the objectmyObj
, but not those in the prototype chain.Object.getOwnPropertyNames()
. This method returns an array containing all the own string property names in the objectmyObj
, regardless of if they are enumerable or not.
You can use the bracket notation withfor...in
to iterate over all the enumerable properties of an object. To illustrate how this works, the following function displays the properties of the object when you pass the object and the object's name as arguments to the function:
function showProps(obj, objName) { let result = ""; for (const i in obj) { // Object.hasOwn() is used to exclude properties from the object's // prototype chain and only show "own properties" if (Object.hasOwn(obj, i)) { result += `${objName}.${i} = ${obj[i]}\n`; } } console.log(result);}
The term "own property" refers to the properties of the object, but excluding those of the prototype chain. So, the function callshowProps(myCar, 'myCar')
would print the following:
myCar.make = FordmyCar.model = MustangmyCar.year = 1969
The above is equivalent to:
function showProps(obj, objName) { let result = ""; Object.keys(obj).forEach((i) => { result += `${objName}.${i} = ${obj[i]}\n`; }); console.log(result);}
There is no native way to list inherited non-enumerable properties. However, this can be achieved with the following function:
function listAllProperties(myObj) { let objectToInspect = myObj; let result = []; while (objectToInspect !== null) { result = result.concat(Object.getOwnPropertyNames(objectToInspect)); objectToInspect = Object.getPrototypeOf(objectToInspect); } return result;}
For more information, seeEnumerability and ownership of properties.
Deleting properties
You can remove a non-inherited property using thedelete
operator. The following code shows how to remove a property.
// Creates a new object, myObj, with two properties, a and b.const myObj = { a: 5, b: 12 };// Removes the a property, leaving myObj with only the b property.delete myObj.a;console.log("a" in myObj); // false
Inheritance
All objects in JavaScript inherit from at least one other object. The object being inherited from is known as the prototype, and the inherited properties can be found in theprototype
object of the constructor. SeeInheritance and the prototype chain for more information.
Defining properties for all objects of one type
You can add a property to all objects created through a certainconstructor using theprototype
property. This defines a property that is shared by all objects of the specified type, rather than by just one instance of the object. The following code adds acolor
property to all objects of typeCar
, and then reads the property's value from an instancecar1
.
Car.prototype.color = "red";console.log(car1.color); // "red"
Defining methods
Amethod is a function associated with an object, or, put differently, a method is a property of an object that is a function. Methods are defined the way normal functions are defined, except that they have to be assigned as the property of an object. See alsomethod definitions for more details. An example is:
objectName.methodName = functionName;const myObj = { myMethod: function (params) { // do something }, // this works too! myOtherMethod(params) { // do something else },};
whereobjectName
is an existing object,methodName
is the name you are assigning to the method, andfunctionName
is the name of the function.
You can then call the method in the context of the object as follows:
objectName.methodName(params);
Methods are typically defined on theprototype
object of the constructor, so that all objects of the same type share the same method. For example, you can define a function that formats and displays the properties of the previously-definedCar
objects.
Car.prototype.displayCar = function () { const result = `A Beautiful ${this.year} ${this.make} ${this.model}`; console.log(result);};
Notice the use ofthis
to refer to the object to which the method belongs. Then you can call thedisplayCar
method for each of the objects as follows:
car1.displayCar();car2.displayCar();
Using this for object references
JavaScript has a special keyword,this
, that you can use within a method to refer to the current object. For example, suppose you have 2 objects,Manager
andIntern
. Each object has its ownname
,age
andjob
. In the functionsayHi()
, notice the use ofthis.name
. When added to the 2 objects, the same function will print the message with the name of the respective object it's attached to.
const Manager = { name: "Karina", age: 27, job: "Software Engineer",};const Intern = { name: "Tyrone", age: 21, job: "Software Engineer Intern",};function sayHi() { console.log(`Hello, my name is ${this.name}`);}// add sayHi function to both objectsManager.sayHi = sayHi;Intern.sayHi = sayHi;Manager.sayHi(); // Hello, my name is KarinaIntern.sayHi(); // Hello, my name is Tyrone
this
is a "hidden parameter" of a function call that's passed in by specifying the object before the function that was called. For example, inManager.sayHi()
,this
is theManager
object, becauseManager
comes before the functionsayHi()
. If you access the same function from another object,this
will change as well. If you use other methods to call the function, likeFunction.prototype.call()
orReflect.apply()
, you can explicitly pass the value ofthis
as an argument.
Defining getters and setters
Agetter is a function associated with a property that gets the value of a specific property. Asetter is a function associated with a property that sets the value of a specific property. Together, they can indirectly represent the value of a property.
Getters and setters can be either
- defined withinobject initializers, or
- added later to any existing object.
Withinobject initializers, getters and setters are defined like regularmethods, but prefixed with the keywordsget
orset
. The getter method must not expect a parameter, while the setter method expects exactly one parameter (the new value to set). For instance:
const myObj = { a: 7, get b() { return this.a + 1; }, set c(x) { this.a = x / 2; },};console.log(myObj.a); // 7console.log(myObj.b); // 8, returned from the get b() methodmyObj.c = 50; // Calls the set c(x) methodconsole.log(myObj.a); // 25
ThemyObj
object's properties are:
myObj.a
— a numbermyObj.b
— a getter that returnsmyObj.a
plus 1myObj.c
— a setter that sets the value ofmyObj.a
to half of the valuemyObj.c
is being set to
Getters and setters can also be added to an object at any time after creation using theObject.defineProperties()
method. This method's first parameter is the object on which you want to define the getter or setter. The second parameter is an object whose property names are the getter or setter names, and whose property values are objects for defining the getter or setter functions. Here's an example that defines the same getter and setter used in the previous example:
const myObj = { a: 0 };Object.defineProperties(myObj, { b: { get() { return this.a + 1; }, }, c: { set(x) { this.a = x / 2; }, },});myObj.c = 10; // Runs the setter, which assigns 10 / 2 (5) to the 'a' propertyconsole.log(myObj.b); // Runs the getter, which yields a + 1 or 6
Which of the two forms to choose depends on your programming style and task at hand. If you can change the definition of the original object, you will probably define getters and setters through the original initializer. This form is more compact and natural. However, if you need to add getters and setters later — maybe because you did not write the particular object — then the second form is the only possible form. The second form better represents the dynamic nature of JavaScript, but it can make the code hard to read and understand.
Comparing objects
In JavaScript, objects are a reference type. Two distinct objects are never equal, even if they have the same properties. Only comparing the same object reference with itself yields true.
// Two variables, two distinct objects with the same propertiesconst fruit = { name: "apple" };const anotherFruit = { name: "apple" };fruit == anotherFruit; // return falsefruit === anotherFruit; // return false
// Two variables, a single objectconst fruit = { name: "apple" };const anotherFruit = fruit; // Assign fruit object reference to anotherFruit// Here fruit and anotherFruit are pointing to same objectfruit == anotherFruit; // return truefruit === anotherFruit; // return truefruit.name = "grape";console.log(anotherFruit); // { name: "grape" }; not { name: "apple" }
For more information about comparison operators, seeequality operators.