Fix #4228 Improved columnInfo type (#4868)

knex · Dec 9, 2021 · 786c95f · 786c95f
1 parent 2bd1811
commit 786c95f
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 5 deletions.
diff --git a/test-tsd/tables.test-d.ts b/test-tsd/tables.test-d.ts
@@ -66,6 +66,29 @@ const main = async () => {
     await knexInstance.first('id').from('users_composite')
   );
 
+  expectType<Record<keyof User, Knex.ColumnInfo>>(
+    await knexInstance<User>('users').columnInfo()
+  );
+  expectType<Record<string | number | symbol, Knex.ColumnInfo>>(
+    await knexInstance('users').columnInfo()
+  );
+  expectType<Record<keyof User, Knex.ColumnInfo>>(
+    await knexInstance('users_inferred').columnInfo()
+  );
+  expectType<Record<keyof User, Knex.ColumnInfo>>(
+    await knexInstance('users_composite').columnInfo()
+  );
+  expectType<Knex.ColumnInfo>(
+    await knexInstance('users_inferred').columnInfo('id')
+  );
+  expectType<Knex.ColumnInfo>(
+    await knexInstance('users_composite').columnInfo('id')
+  );
+  expectType<Knex.ColumnInfo>(await knexInstance('users').columnInfo('id'));
+  expectType<Knex.ColumnInfo>(
+    await knexInstance<User>('users').columnInfo('id')
+  );
+
   //These tests simply check if type work by showing that it does not throw syntax error
 
   knexInstance.schema.createTable('testTable',(table) => {

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -1812,7 +1812,8 @@ export declare namespace Knex {
     and: QueryBuilder<TRecord, TResult>;
 
     // TODO: Promise?
-    columnInfo(column?: keyof TRecord): Promise<ColumnInfo>;
+    columnInfo(column: keyof DeferredKeySelection.Resolve<TRecord>): Promise<ColumnInfo>;
+    columnInfo(): Promise<Record<keyof DeferredKeySelection.Resolve<TRecord>, ColumnInfo>>;
 
     forUpdate(...tableNames: string[]): QueryBuilder<TRecord, TResult>;
     forUpdate(tableNames: readonly string[]): QueryBuilder<TRecord, TResult>;

diff --git a/types/test.ts b/types/test.ts
@@ -2691,16 +2691,16 @@ const main = async () => {
   // # Column Info:
 
   // $ExpectType ColumnInfo
-  await knexInstance('users').columnInfo();
+  await knexInstance('users').columnInfo('id');
 
   // $ExpectType ColumnInfo
-  await knexInstance<User>('users').columnInfo();
+  await knexInstance<User>('users').columnInfo('id');
 
   // $ExpectType ColumnInfo
-  await knexInstance('users_inferred').columnInfo();
+  await knexInstance('users_inferred').columnInfo('id');
 
   // $ExpectType ColumnInfo
-  await knexInstance('users_composite').columnInfo();
+  await knexInstance('users_composite').columnInfo('id');
 
   // # Modify: