Flattening arrays in JavaScript

by Janeth Kent Date: 10-05-2021 javascript


When we are handling arrays that are arrays or have multiple dimensions it can be very useful to know how to flatten arrays in JavaScript. That is to say, to move all the elements to a single dimension. This simplifies things like traversing the elements or being able to dump them into some system.

Until version ES10 (or ES2019) it was a procedure that we had to do by hand, but since this version of the JavaScript standard we already have a method of the Array object that is .flat() and that helps us to flatten arrays in JavaScript.

The first thing to do is to create our multi-dimensional array, which could look something like this:

 
const a=[[1,2],[3,[4,5],6],[7],[8,9,10]];
 

As we can see we have several depths of nested arrays. In the case of having to flatten it by hand we will have to take this depth into account.

The next thing to do is to call the .flat() method:

 
const a_flat = a.flat();
 

Note that if we do not pass any information to the .flat() method it will only flatten the first level. That's why if we traverse the array with JavaScript:

 
for (x=0;x<a_flat.length;x++)    
console.log(a_flat[x]);
 

The console output will be as follows:

 
1  
2  
3  
[4,5]  
6  
7  
8  
9  
10
 

Where we can see that it has not flattened the fourth element, which returns to being an array.

That is why the .flat() method must be given the depth level on which we want to flatten. In this case we are going to pass a level 2:

 
const a_flat = a.flat(2);
 

The console output will be as follows:

 
1  
2  
3  
4  
5  
6  
7  
8  
9  
10
 

Although the .flat() method is already implemented in most major browsers it can be a problem if you have to maintain some browser compatibility.

In this case it is important that you take a look at the compatibility of the .flat() method in Can I Use.

 

Data on support for the array-flat feature across the major browsers from caniuse.com

 

If not, you can always implement a pollyfill like the one below:

 
function flattenDeep(a) {     
   return a.reduce((acc, val) => Array.isArray(val) ? 
   acc.concat(flattenDeep(val)) : acc.concat(val), []);  
   }  
flattenDeep(a);
 

I hope you find it useful to use the .flat() method to flatten arrays in JavaScript. In which cases do you think it would be useful?

 
by Janeth Kent Date: 10-05-2021 javascript hits : 1662  
 
Janeth Kent

Janeth Kent

Licenciada en Bellas Artes y programadora por pasión. Cuando tengo un rato retoco fotos, edito vídeos y diseño cosas. El resto del tiempo escribo en MA-NO WEB DESIGN END DEVELOPMENT.

 
 
 

Related Posts

Difference between arrow and normal functions in JavaScript

In this tutorial we are going to see how arrow functions differ from normal JavaScript functions. We will also see when you should use one and when you should use…

JavaScript Arrow functions: What they are and how to use them

In this article we are going to see what they are and how to use JavaScript Arrow Functions, a new feature introduced with the ES6 standard (ECMAScript 6). What are Arrow…

How to insert an element into an array with JavaScript

In this brief tutorial you will learn how to insert one or more elements into an array with JavaScript. For this we will use the splice function. The splice function will not…

What is the difference between primitives types and objects in JavaScript?

In this short tutorial we are going to look at the differences between primitive types and objects in JavaScript. To start with, we're going to look at what primitive types…

How to get DOM elements with JavaScript

When you access any element of the DOM, it is usual to save it in a variable. This is something that at first might seem very simple, but if you…

How to reverse an array in JavaScript

In this tutorial we are going to see how you can change the order of the elements of an array so that they are inverted. You could use a loop…

How synchronize the scroll of two divs with JavaScript

In case you have two divs of different sizes you may sometimes want to scroll both at the same time but at different speeds depending on their size. For example,…

How to use the codePointAt method in JavaScript

The JavaScript codePointAt method has more or less the same function as the charCodeAt method, used to get the 16-bit Unicode representation of the character at a certain position in…

How to check if a value is a number in JavaScript

In this short tutorial we are going to look at the various methods that exist to find out if a value is a number in JavaScript.   1. Using the isNaN() function   One…

How to use the charCodeAt method in JavaScript

The charCodeAt method is accepted by strings in JavaScript, returning the 16-bit Unicode code of the character at the position we pass as a parameter to the method. The charCodeAt method…

How to use the charAt method in JavaScript

The charAt method is accepted by strings in JavaScript, returning the position of the character passed as a parameter within the string. If the string contains multiple occurrences of the character…

Strings in JavaScript: What they are and how to use them

In this tutorial we are going to explain what strings are and how they are used in JavaScript. The tutorial is intended for people who are learning to program in…

We use our own and third-party cookies to improve our services, compile statistical information and analyze your browsing habits. This allows us to personalize the content we offer and to show you advertisements related to your preferences. By clicking "Accept all" you agree to the storage of cookies on your device to improve website navigation, analyse traffic and assist our marketing activities. You can also select "System Cookies Only" to accept only the cookies required for the website to function, or you can select the cookies you wish to activate by clicking on "settings".

Accept All Only sistem cookies Configuration