backbone-collection-proxy

Create a read-only copy of a backbone collection that stays in sync with the original

npm install backbone-collection-proxy
5 downloads in the last week
59 downloads in the last month

backbone-collection-proxy

Build Status

Create a read-only copy of a backbone collection that stays in sync with the original collection as it's modified, and forwards all of the original collection's events through the proxy.

var original = new Backbone.Collection([ /* ... */ ]);

// Create a new object that will be a read-only proxy of the original model
var proxy = {};
proxyCollection(original, proxy);

// Now we can read values using Backbone.Collection methods on the proxy object
proxy.length === original.length;
proxy.map(function(model) { /* ... */ });
// etc

Why?

This module is somewhat useless on it's own, but it's intended to provide as much of the Backbone.Collection interface to a read-only proxy, so that I can modify and manipulate the proxied collection and expose those changes to the library consumer.

Usage

The following methods are not available on the proxy:

  • add
  • create
  • remove
  • set
  • reset
  • sort
  • parse
  • sync
  • fetch
  • push
  • pop
  • shift
  • unshift
  • models

Additionally, there is no access to the following properties:

  • comparator
  • model
  • url

All other collection methods should work and return the same result as if they were called on the original collection.

Events

Note that events fired on the proxied collection will not also be fired on the original collection. Certain events fired on the original collection will be forwarded to the proxied collection. These events are:

  • add
  • remove
  • reset
  • sort
  • destroy
  • change
  • change:[attribute]

References to the original collection passed as arguments in these events will be replaced with a reference to the proxy collection.

Installation

Usage with Browserify

Install with npm, use with Browserify

> npm install backbone-collection-proxy

and in your code

var proxyCollection = require('backbone-collection-proxy');

Usage with Bower

Install with Bower:

bower install backbone-collection-proxy

The component can be used as a Common JS module, an AMD module, or a global.

Usage as browser global

You can include backbone-sorted-collection.js directly in a script tag. Make sure that it is loaded after underscore and backbone. It's exported as SortedCollection on the global object.

<script src="underscore.js"></script>
<script src="backbone.js"></script>
<script src="backbone-collection-proxy.js"></script>

Testing

Install Node (comes with npm) and Bower.

From the repo root, install the project's development dependencies:

npm install
bower install

Testing relies on the Karma test-runner. If you'd like to use Karma to automatically watch and re-run the test file during development, it's easiest to globally install Karma and run it from the CLI.

npm install -g karma
karma start

To run the tests in Firefox, just once, as CI would:

npm test

If you make any changes you will have to re-build the UMD module that the tests runs against. You can do this by running grunt. You need to install the grunt command line tools globally by running

npm install -g grunt-cli

and then running the following command with no arguments to build

grunt

License

MIT

npm loves you