Lodash _.filter() Method

Lodash _.filter() method iterates over elements of the collection, returning an array of all elements predicate returns true.

Note: This method is not similar to the _.remove() method as this method returns a new array.

Syntax:

_.filter( collection, predicate )

Parameters:

• collection(Array|Object) parameter holds the collection to iterate over.
• predicate(Function) parameter holds the function invoked per iteration.

Return Value:

This method returns the new filtered array.

Example 1: In this example, we are printing the user whose active is false by the use of the function. so we are passing the function in the _.filter() method.

javascript

// Requiring the lodash library
const _ = require("lodash");

// Original array
let users = [
    {
        'user': 'luv',
        'salary': 36000,
        'active': true
    },
    {
        'user': 'kush',
        'salary': 40000,
        'active': false
    }
];

// Using the _.filter() method
let filtered_array = _.filter(
    users, function (o) {
        return !o.active;
    }
);

// Printing the output
console.log(filtered_array);

Output:

[ { user: 'kush', salary: 40000, active: false } ]

Example 2: In this example, we are printing the user whose active is true by the use of the object. so we are passing the object in the _.filter() method.

javascript

// Requiring the lodash library
const _ = require("lodash");

// Original array
let users = [
    {
        'user': 'luv',
        'salary': 36000,
        'active': true
    },
    {
        'user': 'kush',
        'salary': 40000,
        'active': false
    }
];

// Using the _.filter() method
// The `_.matches` iteratee shorthand
let filtered_array = _.filter(users,
    { 'salary': 36000, 'active': true }
);

// Printing the output
console.log(filtered_array);

Output:

[ { user: 'luv', salary: 36000, active: true } ]

Example 3: In this example, we are printing the user whose active is false by the use of the array. so we are passing the array in the _.filter() method.

javascript

// Requiring the lodash library
const _ = require("lodash");

// Original array
let users = [
    {
        'user': 'luv',
        'salary': 36000,
        'active': true
    },
    {
        'user': 'kush',
        'salary': 40000,
        'active': false
    }
];

// Using the _.filter() method
// The `_.matchesProperty` iteratee shorthand
let filtered_array =
    _.filter(users, ['active', false]);

// Printing the output
console.log(filtered_array);

Output:

[ { user: 'kush', salary: 40000, active: false } ]

Example 4: In this example, we are printing the user who has active property. so we are passing the active property in the _.filter() method.

javascript

// Requiring the lodash library
const _ = require("lodash");

// Original array
let users = [
    {
        'user': 'luv',
        'salary': 36000,
        'active': true
    },
    {
        'user': 'kush',
        'salary': 40000,
        'active': false
    }
];

// Using the _.filter() method
// The `_.property` iteratee shorthand
let filtered_array =
    _.filter(users, 'active');

// Printing the output
console.log(filtered_array);

Output:

[ { user: 'luv', salary: 36000, active: true } ]