JavaScript apply() method
Summary: in this tutorial, you’ll learn about the JavaScript apply() method of the Function type and how to use it effectively.
Introduction to the JavaScript apply() method
The Function.prototype.apply() method allows you to call a function with a given this value and arguments provided as an array. Here is the syntax of the apply() method:
fn.apply(thisArg, [args]);
Code language: JavaScript (javascript)
The apply() method accepts two arguments:
- The
thisArgis the value of this provided for the call to the functionfn. - The
argsargument is an array that specifies the arguments of the functionfn. Since the ES5, theargsargument can be an array-like object or array object.
THe apply() method is similar to the call() method except that it takes the arguments of the function as an array instead of the individual arguments.
JavaScript apply() method examples
Let’s take some examples of using the apply() method.
1) Simple JavaScript apply() method example
Suppose that you have a person object:
const person = {
firstName: 'John',
lastName: 'Doe'
}
Code language: JavaScript (javascript)
…and a function named greet() as follows:
function greet(greeting, message) {
return `${greeting} ${this.firstName}. ${message}`;
}
Code language: JavaScript (javascript)
The greet() function accepts two parameters: greeting and message. Inside the greet() function, we reference an object that has the firstName property.
The following example shows how to use the apply() method to call the greet() function with the this set to the person object:
let result = greet.apply(person, ['Hello', 'How are you?']);console.log(result);
Code language: JavaScript (javascript)
Output:
Hello John. How are you?
Code language: JavaScript (javascript)
In this example, we set the this value inside the function to the person object. The arguments of the greet() function was passed into the apply() method as an array.
The apply() method invoked the greet() function with the this value set to the person object and arguments as an array ['Hello', 'How are you?'].
If you use the call() method, you need to pass the arguments of the greet() function separately as follows:
let result = greet.call(person, Hello', 'How are you?');
Code language: JavaScript (javascript)
2) Function borrowing
The apply() method allows an object to borrow the method of another object without duplicating the code.
Suppose that you have the following computer object:
const computer = {
name: 'MacBook',
isOn: false,
turnOn() {
this.isOn = true;
return `The ${this.name} is On`;
},
turnOff() {
this.isOn = false;
return `The ${this.name} is Off`;
}
};
Code language: JavaScript (javascript)
… and the following server object:
const server = {
name: 'Dell PowerEdge T30',
isOn: false
};
Code language: JavaScript (javascript)
The server object doesn’t have the turnOn() and turnOff() methods.
To execute the turnOn() method of the computer object on the server object, you can use the apply() method as follows:
let result = computer.turnOn.apply(server);console.log(result);
Code language: JavaScript (javascript)
Output:
The Dell PowerEdge T30 is On
Code language: JavaScript (javascript)
In this example, the server object borrows the turnOn() method of the computer object.
Similarly, you can call the turnOff() method of the computer object on the server object:
let result = computer.turnOff.apply(server);
console.log(result);Code language: JavaScript (javascript)
Output:
The Dell PowerEdge T30 is OffCode language: JavaScript (javascript)
3) Using the apply() method to append an array to another
The apply() method allows you to append elements of an array to another:
let arr = [1, 2, 3];
let numbers = [4, 5, 6];arr.push.apply(arr, numbers);
console.log(arr);
Code language: JavaScript (javascript)
In this example, the apply() method modifies the original array arr. Note that the Array.prototype.concat() method also provides the same result except that it returns the new array instead of modifying the original array.
Summary
- The
apply()method invokes a function with a giventhisvalue and arguments provided as an array. - The
apply()method is similar to thecall()method excepts that it accepts the arguments of the function as an array instead of individual arguments.