What is the _.flattenDepth() method in Lodash?

Overview

The _.flattenDepth() method in Lodash is used to flatten an array up to a given depth, recursively.

Syntax

Parameters

This method accepts the following parameters:

• array: This is the array to be flattened.
• depth: This is the depth up to which the array is to be flattened.

Return value

This method returns a flattened array.

Example

Let’s look at an example of the _.flattenDepth() method in the code snippet below:

Explanation

In the HTML tab:

• Line 5: We import the lodash script.

In the JavaScript tab:

• Line 2: We create an array and initialize it with a few values.
• Line 5: We create a variable depth and initialize it with 2.

• Line 8: We use the _.flattenDepth() method to flatten the array up to the given depth.
• Line 11: We print the output to the console.

Output

We see an array in which all the values are recursively flattened up to the given depth.