Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix #4228 Improved columnInfo type #4868

Merged
merged 1 commit into from Dec 9, 2021
Merged

Fix #4228 Improved columnInfo type #4868

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 23 additions & 0 deletions test-tsd/tables.test-d.ts
View file
Open in desktop
Expand Up @@ -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) => {
Expand Down
3 changes: 2 additions & 1 deletion types/index.d.ts
View file
Open in desktop
Expand Up @@ -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>;
Expand Down
8 changes: 4 additions & 4 deletions types/test.ts
View file
Open in desktop
Expand Up @@ -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:

Expand Down