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

ParsedOrderBy.md

76 lines1.7 KB

1---
2id: ParsedOrderBy
3title: ParsedOrderBy
4---
5​
6# Interface: ParsedOrderBy
7​
8Defined in: [packages/db/src/query/expression-helpers.ts:82](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L82)
9​
10Result of parsing an ORDER BY expression
11​
12## Properties
13​
14### direction
15​
16```ts
17direction: "asc" | "desc";
18```
19​
20Defined in: [packages/db/src/query/expression-helpers.ts:84](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L84)
21​
22***
23​
24### field
25​
26```ts
27field: FieldPath;
28```
29​
30Defined in: [packages/db/src/query/expression-helpers.ts:83](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L83)
31​
32***
33​
34### locale?
35​
36```ts
37optional locale: string;
38```
39​
40Defined in: [packages/db/src/query/expression-helpers.ts:89](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L89)
41​
42Locale for locale-aware string sorting (e.g., 'en-US')
43​
44***
45​
46### localeOptions?
47​
48```ts
49optional localeOptions: object;
50```
51​
52Defined in: [packages/db/src/query/expression-helpers.ts:91](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L91)
53​
54Additional options for locale-aware sorting
55​
56***
57​
58### nulls
59​
60```ts
61nulls: "first" | "last";
62```
63​
64Defined in: [packages/db/src/query/expression-helpers.ts:85](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L85)
65​
66***
67​
68### stringSort?
69​
70```ts
71optional stringSort: "lexical" | "locale";
72```
73​
74Defined in: [packages/db/src/query/expression-helpers.ts:87](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L87)
75​
76String sorting method: 'lexical' (default) or 'locale' (locale-aware)