fix(types): allow override json function with custom return type (#13694)

Nkmol · s-mol · web-flow · commit 2c3b384cad6d · 2021-11-24T09:24:00.000+01:00
* fix(types): allow override to json function with custom return type

* fix(types): remove automatic linter changes

Co-authored-by: sander-mol &lt;SMol@thepeoplegroup.nl&gt;
diff --git a/types/lib/model.d.ts b/types/lib/model.d.ts
@@ -2888,6 +2888,7 @@ export abstract class Model<TModelAttributes extends {} = any, TCreationAttribut
    * values gotten from the DB, and apply all custom getters.
    */
   public toJSON<T extends TModelAttributes>(): T;
+  public toJSON(): object;
 
   /**
    * Helper method to determine if a instance is "soft deleted". This is
diff --git a/types/test/model.ts b/types/test/model.ts
@@ -215,9 +215,22 @@ class FilmModelToJson extends Model<FilmToJson> implements FilmToJson {
 }
 const film = FilmModelToJson.build();
 
+class FilmModelExtendToJson extends Model<FilmToJson> implements FilmToJson {
+  id!: number;
+  name?: string;
+
+  public toJSON() {
+    return { id: this.id }
+  }
+}
+const filmOverrideToJson = FilmModelExtendToJson.build();
+
 const result = film.toJSON();
 expectTypeOf(result).toEqualTypeOf<FilmToJson>()
 
 type FilmNoNameToJson = Omit<FilmToJson, 'name'>
 const resultDerived = film.toJSON<FilmNoNameToJson>();
-expectTypeOf(resultDerived).toEqualTypeOf<FilmNoNameToJson>()
+expectTypeOf(resultDerived).toEqualTypeOf<FilmNoNameToJson>()
+
+const resultOverrideToJson = filmOverrideToJson.toJSON();
+expectTypeOf(resultOverrideToJson).toEqualTypeOf<FilmNoNameToJson>();
