fix: Improve type inference of paginate method (#20)

felixmosh · Aug 29, 2021 · 0ac3594 · 0ac3594
1 parent 96f51b3
commit 0ac3594
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 6 deletions.
diff --git a/__tests-tsd__/types.test-d.ts b/__tests-tsd__/types.test-d.ts
@@ -1,5 +1,5 @@
 import { knex } from 'knex';
-import { expectType } from 'tsd';
+import { expectType, expectAssignable } from 'tsd';
 import '../types';
 import { ILengthAwarePagination, IBasePagination, IWithPagination } from '../types';
 
@@ -12,8 +12,17 @@ interface User {
 }
 
 (async () => {
-  expectType<IWithPagination<User[]>>(
-    await db('users').select('*').paginate<User[]>({
+  expectAssignable<IWithPagination<User[]>>(
+    await db<User[]>('users').column('*').paginate({
+      perPage: 10,
+      currentPage: 1,
+      isFromStart: true,
+      isLengthAware: false,
+    })
+  );
+
+  expectAssignable<IWithPagination<User[]>>(
+    await db('users').select<User[]>('*').paginate({
       perPage: 10,
       currentPage: 1,
       isFromStart: true,
@@ -51,6 +60,26 @@ interface User {
     ).pagination
   );
 
+  expectType<ILengthAwarePagination>(
+    (
+      await db<User[]>('users').select('*').paginate({
+        perPage: 10,
+        currentPage: 1,
+        isLengthAware: true,
+      })
+    ).pagination
+  );
+
+  expectType<User[]>(
+    (
+      await db<User[]>('users').select('*').paginate({
+        perPage: 10,
+        currentPage: 1,
+        isLengthAware: true,
+      })
+    ).data
+  );
+
   expectType<IBasePagination>(
     (
       await db('users').select('*').paginate({

diff --git a/types.d.ts b/types.d.ts
@@ -33,10 +33,10 @@ interface ILengthAwarePagination extends IBasePagination {
 
 declare module 'knex' {
   namespace Knex {
-    interface QueryBuilder {
-      paginate<TData = any[], TParams extends IPaginateParams = IPaginateParams>(
+    interface QueryBuilder<TRecord extends {} = any, TResult = any> {
+      paginate<TParams extends IPaginateParams = IPaginateParams>(
         params: Readonly<TParams>
-      ): Knex.QueryBuilder<any, IWithPagination<TData, TParams>>;
+      ): Knex.QueryBuilder<TRecord, IWithPagination<TRecord, TParams>>;
     }
   }
 }