lodash Filter collection using array of values

Question

I would like to filter a collection using array of property value. Given an array of IDs, return objects with matching IDs. Is there any shortcut method using lodash/underscore?

var collections = [{ id: 1, name: 'xyz' },
                   { id: 2,  name: 'ds' },
                   { id: 3,  name: 'rtrt' },
                   { id: 4,  name: 'nhf' },
                   { id: 5,  name: 'qwe' }];
var ids = [1,3,4];

// This works, but any better way?

var filtered = _.select(collections, function(c){    
    return ids.indexOf(c.id) != -1
});

Not really. But you could deal directly with the filter() method of Arrays prototypes; looks cleaner :) — gustavohenke
– gustavohenke, Commented Jun 23, 2013 at 1:34

Community · Accepted Answer · 2017-05-23 11:47:18Z

67

If you're going to use this sort of pattern a lot, you could create a mixin like the following, though, it isn't doing anything fundementally different than your original code. It just makes it more developer friendly.

_.mixin({
  'findByValues': function(collection, property, values) {
    return _.filter(collection, function(item) {
      return _.contains(values, item[property]);
    });
  }
});

Then you can use it like this.

var collections = [
    {id: 1, name: 'xyz'}, 
    {id: 2,  name: 'ds'},
    {id: 3,  name: 'rtrt'},
    {id: 4,  name: 'nhf'},
    {id: 5,  name: 'qwe'}
];

var filtered = _.findByValues(collections, "id", [1,3,4]);

Update - This above answer is old and clunky. Please use the answer from Adam Boduch for a much more elegant solution.

_(collections)
  .keyBy('id') // or .indexBy() if using lodash 3.x
  .at(ids)
  .value();

edited May 23, 2017 at 11:47

CommunityBot

11 silver badge

answered Sep 16, 2013 at 14:49

jessegavin

75.8k28 gold badges141 silver badges165 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Damian Green Over a year ago

you're missing the end quote on keyBy. I would correct but SO won't let me add a single character ;)

bholtbholt · Accepted Answer · 2020-09-13 15:46:40Z

49

A concise lodash solution that uses indexBy() and at().

// loDash 4
_.chain(collections)
 .keyBy('id')
 .at(ids)
 .value();

// below loDash 4
_(collections)
 .indexBy('id')
 .at(ids)
 .value();

edited Sep 13, 2020 at 15:46

bholtbholt

13.6k7 gold badges25 silver badges35 bronze badges

answered Nov 23, 2015 at 18:40

Adam Boduch

11.2k3 gold badges32 silver badges38 bronze badges

2 Comments

vhs Over a year ago

This pithiness of this solution is splendid. And Lodash 4 users can simply replace indexBy with keyBy for this to continue functioning.

steezeburger Over a year ago

If collections doesn't contain any objects that match up with ids, it seems to return an array with one element of undefined. [undefined]. This fails my go test of someArray.length so I added a .filter() _(collections).keyBy('id').at(ids).filter().value();

Rock · Accepted Answer · 2016-06-15 11:23:14Z

19

We can also filter like this

var collections = [{ id: 1, name: 'xyz' },
            { id: 2,  name: 'ds' },
            { id: 3,  name: 'rtrt' },
            { id: 4,  name: 'nhf' },
            { id: 5,  name: 'qwe' }];



        var filtered_ids = _.filter(collections, function(p){
            return _.includes([1,3,4], p.id);
        });

        console.log(filtered_ids);

answered Jun 15, 2016 at 11:23

Rock

75814 silver badges39 bronze badges

Comments

edencorbin · Accepted Answer · 2018-04-20 21:50:17Z

12

This worked great for me:

let output = _.filter(collections, (v) => _.includes(ids, v.id));

answered Apr 20, 2018 at 21:50

edencorbin

3,0297 gold badges36 silver badges50 bronze badges

3 Comments

Deano Over a year ago

Thanks, this has worked for me too, yet, I have used reject to simplfiy filter let output = _.reject(collections, v => _.includes(ids, v.id));

indra257 Over a year ago

@edencorbin How can it be achieved if the ids are also a list of objects with both id and name properties

edencorbin Over a year ago

There may be a less code approach but I would reduce that to just the ids, something like const ids = arrayofobjects.map(x=>x.id)

Community · Accepted Answer · 2017-05-23 11:55:04Z

7

I like jessegavin's answer, but I expanded on it using lodash-deep for deep property matching.

var posts = [{ term: { name: 'A', process: '123A' } }, 
             { term: { name: 'B', process: '123B' } }, 
             { term: { name: 'C', process: '123C' } }];

var result = _.filterByValues(posts, 'term.process', ['123A', '123C']);
// results in objects A and C to be returned

jsFiddle

_.mixin({
    'filterByValues': function(collection, key, values) {
        return _.filter(collection, function(o) {
            return _.contains(values, resolveKey(o, key));
        });
    }
});

function resolveKey(obj, key) {
    return (typeof key == 'function') ? key(obj) : _.deepGet(obj, key);
}

If you don't trust lodash-deep or you want support for properties that have dots in their names, here's a more defensive and robust version:

function resolveKey(obj, key) {
    if (obj == null || key == null) {
        return undefined;
    }
    var resolved = undefined;
    if (typeof key == 'function') {
        resolved = key(obj);
    } else if (typeof key == 'string' ) {
        resolved = obj[key];
        if (resolved == null && key.indexOf(".") != -1) {
            resolved = _.deepGet(obj, key);
        }
    }
    return resolved;
}

edited May 23, 2017 at 11:55

CommunityBot

11 silver badge

answered Jan 27, 2015 at 14:54

Benny Bottema

11.6k11 gold badges76 silver badges108 bronze badges

1 Comment

danbars Over a year ago

lodash get is deep by default, so you can do things like _.get(object, 'a[0].b.c');. So all you have to do to make @jessegavin answer support deep properties is change item[property] with _.get(item, property). See lodash documents.

migpok35 · Accepted Answer · 2017-11-20 17:25:57Z

3

These answers didn't work for me, because I wanted to filter on a non-unique value. If you change keyBy to groupBy you can get by.

_(collections)
  .groupBy(attribute)
  .pick(possibleValues)
  .values()
  .flatten()
  .value();

My initial use was to drop things, so I switched out pick with omit.

Thanks Adam Boduch for the starting point.

answered Nov 20, 2017 at 17:25

migpok35

6667 silver badges14 bronze badges

Comments

iSkore · Accepted Answer · 2017-10-26 13:41:25Z

1

I noticed many of these answers are outdated or contain auxiliary functions not listed in Lodash documentation. The accepted answer includes deprecated function _.contains and should be updated.

So here is my ES6 answer.

Based on Lodash v4.17.4

_.mixin( {
    filterByValues: ( c, k, v ) => _.filter(
        c, o => _.indexOf( v, o[ k ] ) !== -1
    )
} );

And invoked as such:

_.filterByValues(
    [
        {
            name: 'StackOverflow'
        },
        {
            name: 'ServerFault'
        },
        {
            name: 'AskDifferent'
        }
    ],
    'name',
    [ 'StackOverflow', 'ServerFault' ]
);

// => [ { name: 'StackOverflow' }, { name: 'ServerFault' } ]

answered Oct 26, 2017 at 13:41

iSkore

7,5793 gold badges36 silver badges61 bronze badges

Comments

Jonatan Kruszewski · Accepted Answer · 2023-06-20 18:48:27Z

0

Sorry to join the party late, but nowadays the clearest way to do it would be by using _.reject

_.reject(collections, ({id}) => _.includes(ids, id));

Basically, we are rejecting all the values that meet a specific criteria, in this case that the ID is included in the ids array.

answered Jun 20, 2023 at 18:48

Jonatan Kruszewski

1,3547 silver badges28 bronze badges

Collectives™ on Stack Overflow

lodash Filter collection using array of values

8 Answers 8

1 Comment

2 Comments

Comments

3 Comments

1 Comment

Comments

Comments

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

8 Answers 8

1 Comment

2 Comments

Comments

3 Comments

1 Comment

Comments

Comments

Comments

Linked

Related