firemodel

FIREMODEL

Powerful Model Support for Firebase

Getting Started

node.js Installation

npm install --save firebase firemodel

var Firebase = require('firebase');
var firemodel = require('firemodel');

Web Installation

bower install --save firemodel

Setup

---

firemodel(Firebase);  //--> adds "model" to the prototype

var ref = new Firebase('https://...');

Using a Model

var Member = ref.model('members');

Member.set('kshunz.active', true);
Member.set('kshunz.name.first', 'K.');
Member.set('kshunz.name.last', 'Shunz');
Member.save();

Query API

---

Getter

Member.get('kshunz');
Member.results.first();

Find (unique filter STRING, field filters ARRAY of STRING)

Member.find();  //--> find all member records
Member.find(['username']);  //--> find all member username
Member.results.all();

Find (unique filter STRING, field filters ARRAY of STRING)

Member.find('kshunz', ['username']);
Member.results.first();  //--> 'kshunz'

Member.find('kshunz');
Member.results.first();  //--> returns entire {}

DAVIE (delete, add, view, index, edit) API

---

[D]elete

Member.delete('kshunz');
Member.save();

[A]dd

Member.add({
  kshunz: {
    username: 'kshunz',
    email: '[e-mail]'
  }
});

Member.save();

[V]iew

Member.view('kshunz');

var currentMember = Member.results.first();

[I]ndex

Member.index();
Member.results.all(); //returns all members

[E]dit

Member.edit('kshunz.username', 'kshunz-admin');
Member.save();