Underscore.js _.compact() Function

Last Updated : 16 Jan, 2024

Underscore.js _.compact() function is used to return an array after removing all the false values. The false values in JavaScript are NaN, undefined, false, 0, null, or an empty string. Its output is an array containing all the even values like the elements of the array, numbers, alphabets, characters, true, etc.

Syntax:

_.compact( list );

Parameters:

list: It holds the array containing the true and false elements.

Return value:

It returns an array containing only true values.

Passing a list of both the true and the false elements to _.compact() function:

The _.compact() function starts by taking the elements one by one and then checks whether it is a false element or not. If it is a false element then it just ignores that element. Otherwise, it adds the true element to the resultant array. Here the false elements are represented as false and an empty string is represented by ''.

Example: This example shows the use of the _.compact() function by passing a list of both the true and the false elements.

HTML

<!DOCTYPE html>
<html>
    <head>
        <script src = 
"https://cdnjs.cloudflare.com/ajax/libs/underscore.js/1.9.1/underscore-min.js" >
        </script>
    </head>
    <body>
        <script type="text/javascript">
            console.log(_.compact([0, 1, false, 2, '', 3]));
        </script>
    </body>
</html>

Output:

Passing a list containing all the false values to the _.compact() function:

If passed array contains all the false elements then the _.compact() function will work the same. It will check each element and since they are all false so all the elements will be ignored. So, the resultant array formed will not have any element and it's length will be 0.

Example: This example shows the use of the _.compact() function by passing a list containing all the false values.

HTML

<!DOCTYPE html>
<html>
    <head>
        <script src = 
"https://cdnjs.cloudflare.com/ajax/libs/underscore.js/1.9.1/underscore-min.js" >
        </script>
    </head>
    <body>
        <script type="text/javascript">
            console.log(_.compact([0, false, '', undefined, NaN]));
        </script>
    </body>
</html>

Output:

Passing a list which contains a false element in '' to _.compact() function:

Pass a false element, undefined inside '' as 'undefined'. Though this is a false element but since it is given inside '' therefore it is treated as a character element. Hence, it is no longer a false element. Rest it works the same as above.

Example: This example shows the use of the _.compact() function by passing a list which contains a false element.

HTML

<!DOCTYPE html>
<html>
    <head>
        <script src = 
"https://cdnjs.cloudflare.com/ajax/libs/underscore.js/1.9.1/underscore-min.js" >
        </script>
    </head>
    <body>
        <script type="text/javascript">
            console.log(_.compact([false, 'HTML', NaN,
                       'CSS', 'undefined']));
        </script>
    </body>
</html>

Output:

Passing a list containing modified false values to the _.compact() function:

The array contains an element as true which is included in the resultant array. The 'no' element is also included as it is inside '' which makes it a character. Also if pass 'no2' it is also not ignored by the _.compact() function.

Example: This example shows the use of the _.compact() function by passing a list containing modified false values.

HTML

<!DOCTYPE html>
<html>
    <head>
        <script src = 
"https://cdnjs.cloudflare.com/ajax/libs/underscore.js/1.9.1/underscore-min.js" >
        </script>
    </head>
    <body>
        <script type="text/javascript">
            console.log(_.compact([false, true, 'yes', 'no', "no2"]));
        </script>
    </body>
</html>

Output:

Note: These commands will not work in Google console or in Firefox as for these additional files need to be added which they didn’t have added. So, add the given links to your HTML file and then run them.

<script type="text/javascript" src =  
"https://cdnjs.cloudflare.com/ajax/libs/underscore.js/1.9.1/underscore-min.js">  
</script>

Underscore.js _.flatten() Function

Sakshi98

Improve

Article Tags :

Practice Tags :

Misc

Underscore.js _.compact() Function

Syntax:

Parameters:

Return value:

Passing a list of both the true and the false elements to _.compact() function:

Passing a list containing all the false values to the _.compact() function:

Passing a list which contains a false element in '' to _.compact() function:

Passing a list containing modified false values to the _.compact() function:

Similar Reads

Underscore.js Collections Functions

Underscore.js Arrays Functions

Underscore.js Functions

Underscore.js Object Functions

Underscore.js Utility Functions

Underscore.js Questions

Thank You!

What kind of Experience do you want to share?