Filtering Backbone.js collection

Question

I'm working with several backbone collections and sometimes I need to access parts of them based on some criteria.

METHOD 1

As already stated in this question, using filter() on the collection itself returns an array of models and not another collection. This can work in simple cases, but it has the effect of losing collection's method concatenation as a plain array of models won't have all methods defined in the collection.

METHOD 2

The answer to that question suggested creating a new collection passing the array of models to the constructor. This works but has the side effect of calling the collection's constructor every time, so any event binding that might be defined there gets stacked on every time you filter the collection.

So what's the correct way to create a sub-collection based on some filter criteria?

Should I use method 1 and create more filtering methods instead on relying on method chaining?

Should I go with method 2 and avoid binding events in the collection's constructor?

jevakallio jevakallio · Accepted Answer · 2013-01-07T17:51:14

Personally I would create more filtering methods on the collection, because it has the additional benefit of encapsulating logic inside the collection.

You could also try to reuse the existing collection. I was toying around with the idea, and arrived at something like this:

var Collection = Backbone.Collection.extend({
  //Takes in n arrays. The first item of each array is the method you want
  //to call and the rest are the arguments to that method. 
  //Sets the collection.models property to the value of each successive filter
  //and returns the result of the last. Revers the collection.models to its original value.
  chainFilters: function(/*args..*/) {
    var models = this.models;
    try {
      filters = _.toArray(arguments);
      _.each(filters, function(filter) {
         this.models = filter[0].apply(this, _.rest(filter));
      }, this);
    } catch(err) {
      this.models = models;
      throw err;
    }

    var filtered = this.models;
    this.models = models;
    return filtered;   
  }
});

Usage:

var results = collection.chainFilters(
  [ collection.filter, function(model) { return model.get('name') === 'foo'; } ],
  [ collection.someMethod, 'someargument' ],
  [ collection.someOtherMethod ]
);

Here's a working sample. It's a bit peculiar, I know.

Filtering Backbone.js collection

2 Answers