Merge pull request #11588 from Automattic/bug/types/update-query

Bug/types/update query
Automattic · Mar 27, 2022 · bfa65e9 · bfa65e9
2 parents cce977d + 781dcb3
commit bfa65e9
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 4 deletions.
diff --git a/test/types/models.test.ts b/test/types/models.test.ts
@@ -1,5 +1,5 @@
-import { Schema, Document, Model, Types, connection, model } from 'mongoose';
-import { expectError } from 'tsd';
+import { UpdateQuery, Schema, Document, Model, Types, connection, model } from 'mongoose';
+import { expectError, expectType } from 'tsd';
 
 function conventionalSyntax(): void {
   interface ITest extends Document {
@@ -211,4 +211,18 @@ function inheritance() {
 
 Project.createCollection({ expires: '5 seconds' });
 Project.createCollection({ expireAfterSeconds: 5 });
-expectError(Project.createCollection({ expireAfterSeconds: '5 seconds' }));
+expectError(Project.createCollection({ expireAfterSeconds: '5 seconds' }));
+
+
+function update() {
+  interface IUser {
+    name: string;
+    age: number;
+    isActive: boolean;
+  }
+  const update: UpdateQuery<IUser> = {};
+
+  expectType<string | undefined>(update.name);
+  expectType<number | undefined>(update.age);
+  expectType<boolean | undefined>(update.isActive);
+}
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -2060,7 +2060,7 @@ declare module 'mongoose' {
    * { age: 30 }
    * ```
    */
-  export type UpdateQuery<T> = _UpdateQuery<_UpdateQueryDef<T>> & AnyObject;
+  export type UpdateQuery<T> = Partial<T> & _UpdateQuery<_UpdateQueryDef<T>> & AnyObject;
 
   export type DocumentDefinition<T> = {
     [K in keyof Omit<T, Exclude<keyof Document, '_id' | 'id' | '__v'>>]: