fix(index.d.ts): support setting type to an array of schemas when u…

…sing SchemaDefinitionType Fix #9962
Automattic · Mar 2, 2021 · bf5a96f · bf5a96f
1 parent 9896ee2
commit bf5a96f
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 2 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -1371,8 +1371,13 @@ declare module 'mongoose' {
     currentTime?: () => (Date | number);
   }
 
+  type Unpacked<T> = T extends (infer U)[] ? U : T;
+
   interface SchemaTypeOptions<T> {
-    type?: T extends string | number | Function ? SchemaDefinitionWithBuiltInClass<T> : T;
+    type?:
+      T extends string | number | Function ? SchemaDefinitionWithBuiltInClass<T> :
+      T extends object[] ? T | Schema<Unpacked<T> & Document>[] :
+      T;
 
     /** Defines a virtual with the given name that gets/sets this path. */
     alias?: string;

diff --git a/test/typescript/schema.ts b/test/typescript/schema.ts
@@ -6,7 +6,23 @@ enum Genre {
   Comedy
 }
 
-const movieSchema: Schema = new Schema({
+interface Actor {
+  name: string,
+  age: number
+}
+const actorSchema =
+  new Schema<Actor & Document, Model<Actor & Document>, Actor>({ name: { type: String }, age: { type: Number } });
+
+interface Movie {
+  title?: string,
+  featuredIn?: string,
+  rating?: number,
+  genre?: string,
+  actionIntensity?: number,
+  actors?: Actor[]
+}
+
+const movieSchema = new Schema<Document<Movie>, Model<Document<Movie>>, Movie>({
   title: String,
   featuredIn: {
     type: String,
@@ -32,6 +48,10 @@ const movieSchema: Schema = new Schema({
       },
       'Action intensity required for action genre'
     ]
+  },
+  actors: {
+    type: [actorSchema],
+    default: undefined
   }
 });