docs

Automattic · Jan 10, 2012 · 42f5329 · 42f5329
1 parent 8a3168d
commit 42f5329
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/lib/document.js b/lib/document.js
@@ -929,6 +929,23 @@ Document.prototype.doQueue = function () {
 /**
  * Gets the document
  *
+ * Available options:
+ *
+ * - getters: apply all getters (path and virtual getters)
+ * - virtuals: apply virtual getters (can override `getters` option)
+ *
+ * Example of only applying path getters:
+ *
+ *     doc.toObject({ getters: true, virtuals: false })
+ *
+ * Example of only applying virtual getters:
+ *
+ *     doc.toObject({ virtuals: true })
+ *
+ * Example of applying both path and virtual getters:
+ *
+ *     doc.toObject({ getters: true })
+ *
  * @return {Object} plain object
  * @api public
  */