Merge pull request #13955 from simllll/patch-7

type: add types for includeResultMetadata
Automattic · Oct 9, 2023 · d7c832e · d7c832e
2 parents d96f505 + d2fec37
commit d7c832e
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/types/models.d.ts b/types/models.d.ts
@@ -32,7 +32,9 @@ declare module 'mongoose' {
     PopulateOption,
     SessionOption {
     limit?: number;
+    // @deprecated, use includeResultMetadata instead
     rawResult?: boolean;
+    includeResultMetadata?: boolean;
     ordered?: boolean;
     lean?: boolean;
     throwOnValidationError?: boolean;

diff --git a/types/query.d.ts b/types/query.d.ts
@@ -124,9 +124,14 @@ declare module 'mongoose' {
     overwriteDiscriminatorKey?: boolean;
     projection?: ProjectionType<DocType>;
     /**
+     * @deprecated use includeResultMetadata instead.
      * if true, returns the raw result from the MongoDB driver
      */
     rawResult?: boolean;
+    /**
+     * if ture, includes meta data for the result from the MongoDB driver
+     */
+    includeResultMetadata?: boolean;
     readPreference?: string | mongodb.ReadPreferenceMode;
     /**
      * An alias for the `new` option. `returnOriginal: false` is equivalent to `new: true`.