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.
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?
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 AND DEVELOPMENT.
Related Posts
How to upload files to the server using JavaScript
In this tutorial we are going to see how you can upload files to a server using Node.js using JavaScript, which is very common. For example, you might want to…
How to combine multiple objects in JavaScript
In JavaScript you can merge multiple objects in a variety of ways. The most commonly used methods are the spread operator ... and the Object.assign() function. How to copy objects with…
The Payment Request API: Revolutionizing Online Payments (Part 2)
In the first part of this series, we explored the fundamentals of the Payment Request API and how it simplifies the payment experience. Now, let's delve deeper into advanced features…
The Payment Request API: Revolutionizing Online Payments (Part 1)
The Payment Request API has emerged as the new standard for online payments, transforming the way transactions are conducted on the internet. In this two-part series, we will delve into…
Let's create a Color Picker from scratch with HTML5 Canvas, Javascript and CSS3
HTML5 Canvas is a technology that allows developers to generate real-time graphics and animations using JavaScript. It provides a blank canvas on which graphical elements, such as lines, shapes, images…
How do you stop JavaScript execution for a while: sleep()
A sleep()function is a function that allows you to stop the execution of code for a certain amount of time. Using a function similar to this can be interesting for…
Mastering array sorting in JavaScript: a guide to the sort() function
In this article, I will explain the usage and potential of the sort() function in JavaScript. What does the sort() function do? The sort() function allows you to sort the elements of…
Infinite scrolling with native JavaScript using the Fetch API
I have long wanted to talk about how infinite scroll functionality can be implemented in a list of items that might be on any Web page. Infinite scroll is a technique…
Sorting elements with SortableJS and storing them in localStorage
SortableJS is a JavaScript extension that you will be able to use in your developments to offer your users the possibility to drag and drop elements in order to change…
What is a JWT token and how does it work?
JWT tokens are a standard used to create application access tokens, enabling user authentication in web applications. Specifically, it follows the RFC 7519 standard. What is a JWT token A JWT token…
Template Literals in JavaScript
Template literals, also known as template literals, appeared in JavaScript in its ES6 version, providing a new method of declaring strings using inverted quotes, offering several new and improved possibilities. About…
How to use the endsWith method in JavaScript
In this short tutorial, we are going to see what the endsWith method, introduced in JavaScript ES6, is and how it is used with strings in JavaScript. The endsWith method is…