Skip to content

docs: specify the array field syntax for invalidate #9137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 17, 2020
Merged

docs: specify the array field syntax for invalidate #9137

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b606888
docs: specify the array field syntax for invalidate
dandv Jun 15, 2020
27ccea6
docs: array field notation for invalidate
dandv Jun 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/document.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2561,7 +2561,7 @@ Document.prototype.validateSync = function(pathsToValidate, options) {
* value: 14 } } }
* })
*
* @param {String} path the field to invalidate
* @param {String} path the field to invalidate. For array elements, use the `array.i.field` syntax, where `i` is the 0-based index in the array.
* @param {String|Error} errorMsg the error which states the reason `path` was invalid
* @param {Object|String|Number|any} value optional invalid value
* @param {String} [kind] optional `kind` property for the error
Expand Down