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

parseLoadSubsetOptions.md

68 lines1.3 KB

1---
2id: parseLoadSubsetOptions
3title: parseLoadSubsetOptions
4---
5​
6# Function: parseLoadSubsetOptions()
7​
8```ts
9function parseLoadSubsetOptions(options): object;
10```
11​
12Defined in: [packages/db/src/query/expression-helpers.ts:499](https://github.com/TanStack/db/blob/main/packages/db/src/query/expression-helpers.ts#L499)
13​
14Convenience function to get all LoadSubsetOptions in a pre-parsed format.
15Good starting point for simple use cases.
16​
17## Parameters
18​
19### options
20​
21The LoadSubsetOptions from ctx.meta
22​
23\{
24`limit?`: `number`;
25`orderBy?`: [`OrderBy`](../@tanstack/namespaces/IR/type-aliases/OrderBy.md);
26`where?`: `BasicExpression`\<`boolean`\>;
27\} | `null` | `undefined`
28​
29## Returns
30​
31`object`
32​
33Pre-parsed filters, sorts, and limit
34​
35### filters
36​
37```ts
38filters: SimpleComparison[];
39```
40​
41### limit?
42​
43```ts
44optional limit: number;
45```
46​
47### sorts
48​
49```ts
50sorts: ParsedOrderBy[];
51```
52​
53## Example
54​
55```typescript
56queryFn: async (ctx) => {
57 const parsed = parseLoadSubsetOptions(ctx.meta?.loadSubsetOptions)
58​
59 // Convert to your API format
60 return api.getProducts({
61 ...Object.fromEntries(
62 parsed.filters.map(f => [`${f.field.join('.')}_${f.operator}`, f.value])
63 ),
64 sort: parsed.sorts.map(s => `${s.field.join('.')}:${s.direction}`).join(','),
65 limit: parsed.limit
66 })
68```