docs(document): add ignoreAtomics option to docs

vkarpov15 · vkarpov15 · commit f7e981626e91 · 2024-01-03T15:55:42.000-05:00
diff --git a/lib/document.js b/lib/document.js
@@ -2219,6 +2219,8 @@ Document.prototype[documentModifiedPaths] = Document.prototype.modifiedPaths;
  *     doc.isDirectModified('documents')     // false
  *
  * @param {String} [path] optional
+ * @param {Object} [options]
+ * @param {Boolean} [options.ignoreAtomics=false] If true, doesn't return true if path is underneath an array that was modified with atomic operations like `push()`
  * @return {Boolean}
  * @api public
  */

Original file line number	Diff line number	Diff line change
`@@ -2219,6 +2219,8 @@ Document.prototype[documentModifiedPaths] = Document.prototype.modifiedPaths;`
`2219`	`2219`	`* doc.isDirectModified('documents') // false`
`2220`	`2220`	`*`
`2221`	`2221`	`* @param {String} [path] optional`
	`2222`	`+ * @param {Object} [options]`
	`2223`	+ * @param {Boolean} [options.ignoreAtomics=false] If true, doesn't return true if path is underneath an array that was modified with atomic operations like `push()`
`2222`	`2224`	`* @return {Boolean}`
`2223`	`2225`	`* @api public`
`2224`	`2226`	`*/`