Merge pull request #13636 from omran95/omran95/add-inline-comment-to-…

…runValidators-query-types Types: Add inline comment to to tell the default value of the runValidator flag in the queryOptions types
Automattic · Jul 20, 2023 · faf6bf7 · faf6bf7
2 parents c44926c + 786a406
commit faf6bf7
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/types/query.d.ts b/types/query.d.ts
@@ -136,6 +136,10 @@ declare module 'mongoose' {
      * Another alias for the `new` option. `returnOriginal` is deprecated so this should be used.
      */
     returnDocument?: 'before' | 'after';
+    /**
+     * Set to true to enable `update validators`
+     * (https://mongoosejs.com/docs/validation.html#update-validators). Defaults to false.
+     */
     runValidators?: boolean;
     /* Set to `true` to automatically sanitize potentially unsafe user-generated query projections */
     sanitizeProjection?: boolean;