types(model): add missing function signature for model() to match `…

…$model()` re: #13963
Automattic · Oct 11, 2023 · 46a6ecc · 46a6ecc
1 parent 430f7ad
commit 46a6ecc
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/test/types/document.test.ts b/test/types/document.test.ts
@@ -302,6 +302,7 @@ function gh13878() {
   const User = model('User', schema);
   const user = new User({ name: 'John', age: 30 });
   expectType<typeof User>(user.$model());
+  expectType<typeof User>(user.model());
 }
 
 function gh13094() {

diff --git a/types/document.d.ts b/types/document.d.ts
@@ -192,6 +192,10 @@ declare module 'mongoose' {
     markModified<T extends keyof DocType>(path: T, scope?: any): void;
     markModified(path: string, scope?: any): void;
 
+    /** Returns the model with the given name on this document's associated connection. */
+    model<ModelType = Model<unknown>>(name: string): ModelType;
+    model<ModelType = Model<DocType>>(): ModelType;
+
     /** Returns the list of paths that have been modified. */
     modifiedPaths(options?: { includeChildren?: boolean }): Array<string>;