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