Skip to content

fix(postgrest): correct order() overload typing for referenced tables #2025

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

Open
DevanshTyagi04 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(postgrest): correct order() overload typing for referenced tables #2025

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 0 additions & 11 deletions packages/core/postgrest-js/src/PostgrestTransformBuilder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,21 +72,10 @@ export default class PostgrestTransformBuilder<
>
}

order<ColumnName extends string & keyof Row>(
column: ColumnName,
options?: { ascending?: boolean; nullsFirst?: boolean; referencedTable?: undefined }
): this
order(
column: string,
options?: { ascending?: boolean; nullsFirst?: boolean; referencedTable?: string }
): this
/**
* @deprecated Use `options.referencedTable` instead of `options.foreignTable`
*/
order<ColumnName extends string & keyof Row>(
column: ColumnName,
options?: { ascending?: boolean; nullsFirst?: boolean; foreignTable?: undefined }
): this
Comment on lines -75 to -89
Copy link
Member

@steve-chavez steve-chavez Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if this will produce the intended behavior. @avallete Could you help review 🙏 ?

Copy link
Member

@avallete avallete Feb 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The overload are here to hint Typescript into correct auto-completion. Without this I think you'll never have autocomplete within the function arg 🤔

/**
* @deprecated Use `options.referencedTable` instead of `options.foreignTable`
*/
Expand Down