bindable.Collection operates like arrays, except they're watchable if anything changes.

Installation

npm install bindable-collection --save-exact

Collection(source)

The constructor

1var BindableCollection = require("bindable-collection");
2var items = new BindableCollection([1, 2, 3]);
3console.log(items.at(0));
4console.log(items.at(1));
5console.log(items.at(2));
6console.log(items.source);

source

The source of the collection. This is an array.

reset(source)

Resets the source of the collection. You can also do this by calling set('source', array)

1var BindableCollection = require("bindable-collection");
2var items = new BindableCollection([1, 2, 3]);
3console.log(items.source);
4items.reset([4, 5, 6]);
5console.log(items.source);
6items.set("source", [7, 8, 9]);
7console.log(items.source);

indexOf(item)

returns the index of an item

1var BindableCollection = require("bindable-collection");
2var items = new BindableCollection([1, 2, 3]);
3console.log(items.indexOf(1));

value at(index)

returns an item at the given index

each(fn)

iterates through the collection. similar to array.forEach.

push(values...)

pushes items to the end of the collection.

unshift(values...)

unshifts items to the beginning of the collection.

splice(index, count[, newValues...])

removes items from the collection

value pop()

pops the last item off the collection

value shift()

removes the first item from the collection

Events

• insert - emitted when items are inserted
• update - emitted when the collection is updated
• reset - emitted when the source has been reset
• remove - emitted when items have been removed

1var BindableCollection = require("bindable-collection");
2var items = new BindableCollection([1, 2, 3]);
3
4items.on("insert", function (result) {
5  console.log("insert ", result);
6});
7
8items.on("remove", function (result) {
9  console.log("remove ", result);
10});
11
12items.on("update", function (result) {
13  console.log("update ", result);
14});
15
16items.on("reset", function (result) {
17  console.log("reset ", result);
18});
19
20items.reset([2, 3, 4]);
21items.splice(1, 2);
22items.push(6);
23items.pop();
24items.shift();