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.

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

Extend typing to make JSON expressions work with order #390

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
16 changes: 9 additions & 7 deletions src/PostgrestTransformBuilder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ import {
PostgrestSingleResponse,
} from './types'

/* Extract the column name from a potential JSON accessor expression. */
type ColumnName<T extends string> =
T extends `${infer TName}->${infer _TRest}` ? TName : T

export default class PostgrestTransformBuilder<
Schema extends GenericSchema,
Row extends Record<string, unknown>,
Expand Down Expand Up @@ -46,13 +50,11 @@ export default class PostgrestTransformBuilder<
return this as unknown as PostgrestTransformBuilder<Schema, Row, NewResult>
}

order<ColumnName extends string & keyof Row>(
column: ColumnName,
options?: { ascending?: boolean; nullsFirst?: boolean; foreignTable?: undefined }
): this
order(
column: string,
options?: { ascending?: boolean; nullsFirst?: boolean; foreignTable: string }
order<ColExpr extends string, ColName = ColumnName<ColExpr>>(
column: ColExpr,
options?: ColName extends keyof Row ?
{ ascending?: boolean; nullsFirst?: boolean; foreignTable?: string } :
{ ascending?: boolean; nullsFirst?: boolean; foreignTable: string }
): this
/**
* Order the query result by `column`.
Expand Down