rekord-firebase v1.5.6

rekord-firebase

A rekord binding to firebase - implementing Rekord.rest (Rekord.live & Rekord.store implicitly)

The easiest way to install is by using bower via bower install rekord-firebase.

• rekord-firebase.js is 5.6KB (1.1KB gzipped)
• rekord-firebase.min.js is 1.9KB (0.7KB gzipped)

Example Usage

var fire = firebase.database();

// Executed after options are applied but before the store, rest, & live
// implementations are added. It's good to prepare your database in this
// function so if you switch backends there's only one place you need to do so.
// You can also pass a prepare function as a Rekord option.
Rekord.Defaults.prepare = function(db, options) {
  db.api = options.api || fire.ref( options.name );
};

// Default behavior
var TaskList = Rekord({
  name: 'task_list',
  field: ['name', 'done']
});

// Override (or default behavior if prepare method isn't used like above)
var Task = Rekord({
  name: 'task',
  api: fire.ref('task'),
  field: ['name', 'done', 'task_list_id']
});

// Or dynamically return a firebase reference
var Item = Rekord({
  name: 'item',
  fields: ['name', 'list_id'],
  // for all, create, update, remove & query (when getQueryFirebase is not given)
  getFirebase: function(model, database) {
    // model is undefined for all() and query() functions
    return fire.ref( 'list/' + model.list_id + '/items' );
  },
  // for query
  getQueryFirebase: function(url, data) {
    return fire.ref( url );
  }
  // which reference to listen to for child events
  getLiveFirebase: function(database) {
    return fire.ref( database.name );
  }
});

Querying Example

// API REMINDER: Task.search( url, options, data, run? )

// Querying by passing an object where the keys are functions to execute on
// the query and the values are the argument to pass to the function.
var queryObject = {
  orderByChild: 'name',
  limitToFirst: 10
};
var search = Task.search( 'task', {} , queryObject, true );
search.$results; // 0-10 tasks ordered by name

// Querying by passing a function which is given a Firebase query object which
// you can call its functions as you desire.
var queryFunction = function(query) {
  query.orderByChild('name');
  query.limitToLast(10);
};
var customSearch = Task.search( 'task', {}, queryFunction, true );
customSearch.$results; // 0-10 tasks ordered by name (descending order)