fireproof/lib/snapshot.js

Promises for Firebase objects.

/**
 * A delegate object for Firebase's Snapshot.
 * @name FireproofSnapshot
 * @constructor
 * @global
 * @private
 * @param {Snapshot} snap The snapshot to delegate to.
 */
function FireproofSnapshot(snap) {
  this._snap = snap;
}

Fireproof.Snapshot = FireproofSnapshot;


/**
 * Delegates DataSnapshot#exists.
 * @method FireproofSnapshot#exists
 * @returns {Boolean} Whether any data exists at the location.
 */
FireproofSnapshot.prototype.exists = function() {
  return this._snap.exists();
};



/**
 * Delegates DataSnapshot#child.
 * @method FireproofSnapshot#child
 * @param {String} path Path of the child.
 * @returns {FireproofSnapshot} The snapshot of the child.
 */
FireproofSnapshot.prototype.child = function(path) {
  return new FireproofSnapshot(this._snap.child(path));
};


/**
 * Delegates DataSnapshot#forEach.
 * @method FireproofSnapshot#forEach
 * @param {cb} eachFn The function to call on each child.
 * @returns {Boolean} True if a callback returned true and cancelled enumeration.
 */
FireproofSnapshot.prototype.forEach = function(cb) {

  return this._snap.forEach(function(childSnap) {
    if (cb(new FireproofSnapshot(childSnap)) === true) {
      return true;
    }
  });

};


/**
 * Delegates DataSnapshot#hasChild.
 * @method FireproofSnapshot#hasChild
 * @param {cb} eachFn The function to call on each child.
 * @returns {Boolean} True if the snap has the specified child.
 */
FireproofSnapshot.prototype.hasChild = function(name) {
  return this._snap.hasChild(name);
};


/**
 * Delegates DataSnapshot#hasChildren.
 * @method FireproofSnapshot#hasChildren
 * @returns {Boolean} True if the snapshot has children.
 */
FireproofSnapshot.prototype.hasChildren = function() {
  return this._snap.hasChildren();
};


/**
 * Delegates DataSnapshot#numChildren.
 * @method FireproofSnapshot#numChildren
 * @returns {Number} The number of children the snapshot has.
 */
FireproofSnapshot.prototype.numChildren = function() {
  return this._snap.numChildren();
};


/**
 * Delegates DataSnapshot#name.
 * @method FireproofSnapshot#name
 * @returns {String} The last part of the snapshot's path.
 */
FireproofSnapshot.prototype.name = function() {
  return this._snap.name();
};


/**
 * Delegates DataSnapshot#key.
 * @method FireproofSnapshot#key
 * @returns {String} The last part of the snapshot's path.
 */
FireproofSnapshot.prototype.key = function() {
  return this._snap.key();
};


/**
 * Delegates DataSnapshot#val.
 * @method FireproofSnapshot#val
 * @returns {*} The Javascript deserialization of the snapshot.
 */
FireproofSnapshot.prototype.val = function() {
  return this._snap.val();
};


/**
 * Delegates DataSnapshot#ref.
 * @method FireproofSnapshot#ref
 * @returns {Fireproof} The Fireproof object for the snap's location.
 */
FireproofSnapshot.prototype.ref = function() {
  return new Fireproof(this._snap.ref());
};


/**
 * Delegates DataSnapshot#getPriority.
 * @method FireproofSnapshot#getPriority
 * @returns {*} The snapshot's priority.
 */
FireproofSnapshot.prototype.getPriority = function() {
  return this._snap.getPriority();
};


/**
 * Delegates DataSnapshot#exportVal.
 * @method FireproofSnapshot#exportVal
 * @returns {*} The Firebase export object of the snapshot.
 */
FireproofSnapshot.prototype.exportVal = function() {
  return this._snap.exportVal();
};