Backbone-kinship

A simple, lightweight, Backbone model adding 1-1 and 1-N relations. No shared instances, data pooling or reversed relations. It's really just a way to expand nested data into models and collections.

Creating a model with relations

var Fruits = Backbone.Collection.extend({});
var Robot = Backbone.Model.extend({});

var MyRelationalModel = Backbone.RelationalModel.extend({
  relations: {
    myFirstRelation: Fruits,
    myOtherRelation: Robot
  }
});

var myRelationalModelInstance = new MyRelationalModel({
  "myFirstRelation": [
    {
      "type": "banana",
      "eatenBy": "monkey"
    },
    {
      "type": "apple",
      "eatenBy": "horse"
    }
  ],
  "myOtherRelation": {
    "name": "Bender Rodriguez"
  }
});

Accessing data on a related model or collection

After instantiating a Backbone.RelationalModel you can access the related models and collections by getting them like so:

console.log(myRelationalModelInstance.get("myFirstRelation").at(0).get("type"));
>> "banana"

console.log(myRelationalModelInstance.get("myOtherRelation").get("name"));
>> "Bender Rodriguez"

... or alternatively:

console.log(myRelationalModelInstance.myOtherRelation.get("name"));
>> "Bender Rodriguez"

Events

Events are propagated from their relationships as eventName:relationshipName. The following events also triggers a change event: "add", "remove", "change", "reset". Like so:

myRelationalModelInstance.on("all", function(e) {
  console.log(e);
});

myRelationalModelInstance.get("myFirstRelation").add({
  type: "bamboo",
  eatenBy: "panda"
});

>> "change"
>> "add:myFirstRelation"

---

Backbone-kinship is released under the MIT license. Contributors: https://github.com/Oktavilla/backbone-kinship/contributors