Skip to content

Update spec for WithMethod #2750

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update spec for WithMethod #2750

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
1 change: 1 addition & 0 deletions typings/objection/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -597,6 +597,7 @@ declare namespace Objection {

interface WithMethod<QB extends AnyQueryBuilder> {
(alias: string, expr: CallbackVoid<QB> | AnyQueryBuilder | Raw): QB;
(alias: string, columns: string[], expr: CallbackVoid<QB> | AnyQueryBuilder | Raw): QB;
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm no TS specialist and don't personally use typings, but columns is optional, and this doesn't seem to be reflected here? Please make sure the typings work for both patterns, with and without columns.

Copy link
Author

@salisbury-espinosa salisbury-espinosa May 27, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Please make sure the typings work for both patterns, with and without columns

@lehni
so here it is without already above:
(alias: string, expr: CallbackVoid<QB> | AnyQueryBuilder | Raw): QB;

I added - where "with columns" ( (alias: string, columns: string[], expr: CallbackVoid<QB> | AnyQueryBuilder | Raw): QB;)

I'm already using this patch in production (see ts-patch )

I'm no TS specialist and don't personally use typings

we simply declare multiple signatures for functions via an interface (overload signatures)

}

interface JoinRelatedOptions {
Expand Down