The Array method unshift() in Apps Script
The Array method unshift() adds one or more elements to the beginning of an array and returns its new size.
Prerequisites
This tutorial assumes that you're familiar with:
Basic Apps Script concepts (such as Arrays in Apps Script).
How to create and run simple Apps Script scripts using the script editor in Google Sheets.
Syntaxarray.unshift(val, val2, …, val3)
Parameters
array.unshift(val, val2, …, val3)One or more values to be added to the beginning of the array.
Return value
The length of the array after adding elements to it.
Examples
The code below uses the unshift() array method to add elements to the beginning of the array colors.
🛈 Note
In Apps Script, you can only run functions. So you have to copy and paste the code snippet below into a function before you run it.
var colors = ["red", "blue"];
Logger.log(colors);
Logger.log(colors.length);
// Adding just one element
var length = colors.unshift('purple');
Logger.log(colors);
Logger.log(length);
// Adding two elements
length = colors.unshift('green', 'yellow');
Logger.log(colors);
Logger.log(length);Output
[red, blue]
2.0
[purple, red, blue]
3.0
[green, yellow, purple, red, blue]
5.0
Conclusion
In this tutorial, you learned how to use the unshift() array method to add elements to the beginning of an array.