Skip to content
Source
Sign inSign up
TanStack/db
Open History to see the last commit

ParsedOrderBy.md

76 lines1.7 KB

Interface: ParsedOrderBy

Defined in: packages/db/src/query/expression-helpers.ts:82

Result of parsing an ORDER BY expression

Properties

direction

direction: "asc" | "desc";

Defined in: packages/db/src/query/expression-helpers.ts:84


field

field: FieldPath;

Defined in: packages/db/src/query/expression-helpers.ts:83


locale?

optional locale: string;

Defined in: packages/db/src/query/expression-helpers.ts:89

Locale for locale-aware string sorting (e.g., 'en-US')


localeOptions?

optional localeOptions: object;

Defined in: packages/db/src/query/expression-helpers.ts:91

Additional options for locale-aware sorting


nulls

nulls: "first" | "last";

Defined in: packages/db/src/query/expression-helpers.ts:85


stringSort?

optional stringSort: "lexical" | "locale";

Defined in: packages/db/src/query/expression-helpers.ts:87

String sorting method: 'lexical' (default) or 'locale' (locale-aware)