populate; add doc.populated()

Automattic · Feb 3, 2013 · 89b97e0 · 89b97e0
1 parent 89cedc6
commit 89b97e0
Showing 1 changed file with 15 additions and 1 deletion.
diff --git a/lib/document.js b/lib/document.js
@@ -1550,7 +1550,21 @@ Document.prototype.equals = function (doc) {
   return tid.equals
     ? tid.equals(docid)
     : tid === docid;
-};
+}
+
+/**
+ * Returns value(s) retreived during population.
+ *
+ * If the path was not populated, undefined is returned. Otherwise, the population result is returned.
+ *
+ * @param {String} path
+ * @return {Array|Document|null|undefined}
+ */
+
+Document.prototype.populated = function (path) {
+  if (!this.$__.populated) return undefined;
+  return this.$__.populated[path];
+}
 
 /*!
  * Module exports.