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 : 1189  
 
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

Dates in local format with Javascript

In the articles we have about dates in JavaScript we were missing one about how to create dates in local format with JavaScript. That is to say, being able to…

Formatting hours in Javascript

Continuing with the set of articles that talk about internationalisation elements, like the previous one where we talked about relative dates in JavaScript, we will see in this one how…

Request data with prompt in JavaScript

After having published several articles about how to manipulate arrays and dates, today I will publish a post that some of you will find too basic and others will find…

Relative dates in JavaScript

One of the interesting things about the internationalisation library represented in the Int object is the handling of relative dates in Javascript. This handling allows us to represent a date…

How to access webcam and grab an image using HTML5 and Javascript

We often use webcams to broadcast video in real time via our computer. This broadcast can be viewed, saved and even shared via the Internet. As a rule, we need…

The JavaScript forEach loop

We have already talked about how to handle some of loops  types in Javascript including for, for-in and for-off loops. In the case of today we are going to see how…

What are React Hooks and what problems they solve

Working with React, - and before the release of Hooks in version 16.8 -  there was always the possibility to create components in three different ways based on a number of…

How to populate an array with random numbers in JavaScript

Some of you might think that what we explained in the article on how to populate an array with numbers, apart from the didactic part, would not have much applicability…

How to populate an array with numbers in JavaScript

Populate an array with numbers in JavaScript The first step is to initialise the array. So today we are going to see a simple way to do it and see how…

Top Javascript Libraries and Frameworks Part 2

What are JavaScript frameworks?   JavaScript frameworks are application frameworks that allow developers to manipulate code to meet their particular needs. Web application development is like building a house. You have the option…

How to Send Email from an HTML Contact Form

In today’s article we will write about how to make a working form that upon hitting that submit button will be functional and send the email (to you as a…

Top JavaScript libraries and frameworks part 1

JavaScript libraries and frameworks make it easy to develop websites and applications with a wide variety of features and functionality, all with dynamic, flexible and engaging features. According to a 2020…

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