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

parseOrderByExpression.md

38 lines874 Bytes

1---
2id: parseOrderByExpression
3title: parseOrderByExpression
4---
5​
6# Function: parseOrderByExpression()
7​
8```ts
9function parseOrderByExpression(orderBy): ParsedOrderBy[];
10```
11​
12Defined in: [packages/db/src/query/expression-helpers.ts:265](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L265)
13​
14Parses an ORDER BY expression into a simple array of sort specifications.
15​
16## Parameters
17​
18### orderBy
19​
20The ORDER BY expression array
21​
22[`OrderBy`](../@tanstack/namespaces/IR/type-aliases/OrderBy.md) | `null` | `undefined`
23​
24## Returns
25​
26[`ParsedOrderBy`](../interfaces/ParsedOrderBy.md)[]
27​
28Array of parsed order by specifications
29​
30## Example
31​
32```typescript
33const sorts = parseOrderByExpression(orderBy)
34// Returns: [
35// { field: ['category'], direction: 'asc', nulls: 'last' },
36// { field: ['price'], direction: 'desc', nulls: 'last' }
37// ]
38```