Merge pull request #13117 from Automattic/IslandRhythms/paths-generic

Add Path generic
Automattic · Mar 2, 2023 · 416784e · 416784e
2 parents 7d2c511 + 66d0235
commit 416784e
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 5 deletions.
diff --git a/test/types/populate.test.ts b/test/types/populate.test.ts
@@ -339,3 +339,33 @@ function gh12136() {
   }
 
 }
+
+async function gh13070() {
+  interface IParent {
+    name: string;
+    child: Types.ObjectId;
+  }
+  interface IChild {
+    name: string;
+    parent: Types.ObjectId;
+  }
+
+  const parentSchema = new Schema(
+    {
+      name: { type: String, required: true },
+      child: { type: Schema.Types.ObjectId, ref: 'Child', required: true }
+    });
+
+  const childSchema = new Schema(
+    {
+      name: { type: String, required: true },
+      parent: { type: Schema.Types.ObjectId, ref: 'Parent', required: true }
+    });
+
+  const Parent = model<IParent>('Parent', parentSchema);
+  const Child = model<IChild>('Child', childSchema);
+
+  const doc = await Parent.findOne().orFail();
+  const doc2 = await Child.populate<{ child: IChild }>(doc, 'child');
+  const name: string = doc2.child.name;
+}
diff --git a/types/models.d.ts b/types/models.d.ts
@@ -299,11 +299,22 @@ declare module 'mongoose' {
     modelName: string;
 
     /** Populates document references. */
-    populate(docs: Array<any>, options: PopulateOptions | Array<PopulateOptions> | string,
-      callback?: Callback<(HydratedDocument<T, TMethodsAndOverrides, TVirtuals>)[]>): Promise<Array<HydratedDocument<T, TMethodsAndOverrides, TVirtuals>>>;
-    populate(doc: any, options: PopulateOptions | Array<PopulateOptions> | string,
-      callback?: Callback<HydratedDocument<T, TMethodsAndOverrides, TVirtuals>>): Promise<HydratedDocument<T, TMethodsAndOverrides, TVirtuals>>;
-
+    populate(
+      docs: Array<any>,
+      options: PopulateOptions | Array<PopulateOptions> | string
+    ): Promise<Array<HydratedDocument<T, TMethodsAndOverrides, TVirtuals>>>;
+    populate(
+      doc: any,
+      options: PopulateOptions | Array<PopulateOptions> | string,
+    ): Promise<HydratedDocument<T, TMethodsAndOverrides, TVirtuals>>;
+    populate<Paths>(
+      docs: Array<any>,
+      options: PopulateOptions | Array<PopulateOptions> | string
+    ): Promise<MergeType<HydratedDocument<T, TMethodsAndOverrides, TVirtuals>, Paths>[]>;
+    populate<Paths>(
+      doc: AnyObject,
+      options: PopulateOptions | Array<PopulateOptions> | string
+    ): Promise<MergeType<HydratedDocument<T, TMethodsAndOverrides, TVirtuals>, Paths>>;
 
     /** Casts and validates the given object against this model's schema, passing the given `context` to custom validators. */
     validate(callback?: CallbackWithoutResult): Promise<void>;