Merge pull request #15318 from baruchiro/types/with-timestamps

feat(types): add WithTimestamps utility type

Author: vkarpov15

test/types/utility.test.ts

@@ -1,4 +1,4 @@
-import { MergeType } from 'mongoose';
+import { MergeType, WithTimestamps } from 'mongoose';
 import { expectType } from 'tsd';
 
 type A = { a: string, c: number };
@@ -11,3 +11,21 @@ expectType<number>({} as MergeType<B, A>['c']);
 expectType<number>({} as MergeType<A, B>['a']);
 expectType<string>({} as MergeType<A, B>['b']);
 expectType<number>({} as MergeType<A, B>['c']);
+
+type C = WithTimestamps<{ a: string; b: string }>;
+expectType<string>({} as C['a']);
+expectType<string>({} as C['b']);
+expectType<Date>({} as C['createdAt']);
+expectType<Date>({} as C['updatedAt']);
+
+type D = WithTimestamps<
+  { a: string; b: string },
+  {
+    createdAt: 'created';
+    updatedAt: 'modified';
+  }
+>;
+expectType<string>({} as D['a']);
+expectType<string>({} as D['b']);
+expectType<Date>({} as D['created']);
+expectType<Date>({} as D['modified']);

types/utility.d.ts

@@ -93,4 +93,12 @@ type AddThisParameter<T, D> = {
     : T[K];
 };
 
+  /**
+   * @summary Adds timestamp fields to a type
+   * @description Adds createdAt and updatedAt fields of type Date, or custom timestamp fields if specified
+   * @param {T} T The type to add timestamp fields to
+   * @param {P} P Optional SchemaTimestampsConfig or boolean to customize timestamp field names
+   * @returns T with timestamp fields added
+   */
+  export type WithTimestamps<T, P extends SchemaTimestampsConfig | boolean = true> = ResolveTimestamps<T, { timestamps: P }>;
 }