fix(types): indicate that Schema.prototype.discriminator() returns `t…

…his` Fix #12457
Automattic · Oct 4, 2022 · a15242d · a15242d
1 parent 140524c
commit a15242d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 7 deletions.
diff --git a/test/types/schema.test.ts b/test/types/schema.test.ts
@@ -570,9 +570,7 @@ export type AutoTypedSchemaType = {
 // discriminator
 const eventSchema = new Schema<{ message: string }>({ message: String }, { discriminatorKey: 'kind' });
 const batchSchema = new Schema<{ name: string }>({ name: String }, { discriminatorKey: 'kind' });
-const discriminatedSchema = batchSchema.discriminator('event', eventSchema);
-
-expectType<Schema<Omit<{ name: string }, 'message'> & { message: string }>>(discriminatedSchema);
+batchSchema.discriminator('event', eventSchema);
 
 // discriminator statics
 const eventSchema2 = new Schema({ message: String }, { discriminatorKey: 'kind', statics: { static1: function() {
@@ -581,9 +579,7 @@ const eventSchema2 = new Schema({ message: String }, { discriminatorKey: 'kind',
 const batchSchema2 = new Schema({ name: String }, { discriminatorKey: 'kind', statics: { static2: function() {
   return 1;
 } } });
-const discriminatedSchema2 = batchSchema2.discriminator('event', eventSchema2);
-
-expectAssignable<Schema<Omit<{ name: string }, 'message'> & { message: string }, Model<any>, {}, {}, {}, { static1(): number; static2(): number; }>>(discriminatedSchema2);
+batchSchema2.discriminator('event', eventSchema2);
 
 function gh11828() {
   interface IUser {

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -208,7 +208,7 @@ declare module 'mongoose' {
     /** Returns a copy of this schema */
     clone<T = this>(): T;
 
-    discriminator<DisSchema = Schema>(name: string, schema: DisSchema): DiscriminatorSchema<DocType, M, TInstanceMethods, TQueryHelpers, TVirtuals, TStaticMethods, DisSchema>;
+    discriminator<DisSchema = Schema>(name: string, schema: DisSchema): this;
 
     /** Returns a new schema that has the picked `paths` from this schema. */
     pick<T = this>(paths: string[], options?: SchemaOptions): T;