Skip to content
Source
Sign inSign up
TanStack/db

feat: add expression helpers for parsing LoadSubsetOptions in queryFn #786

MergedKyleAMathews(GitHub profile, opens in a new tab)merged 14 commits intoquery-driven-sync fromrefs/pull/786/headmerged by samwillis(GitHub profile, opens in a new tab)

Showing 8 changed files with 39 additions and 0 deletions (loading 7).

x
0 of 8 viewed, 8 left
39 additions and 0 deletions.changeset/expression-helpers-queryfn.mdAdded
View file
@@ -0,0 +1,39 @@
+---
+"@tanstack/db": patch
+"@tanstack/query-db-collection": patch
+---
+​
+Add expression helper utilities for parsing LoadSubsetOptions in queryFn.
+​
+When using `syncMode: 'on-demand'`, TanStack DB now provides helper functions to easily parse where clauses, orderBy, and limit predicates into your API's format:
+​
+- `parseWhereExpression`: Parse where clauses with custom handlers for each operator
+- `parseOrderByExpression`: Parse order by into simple array format
+- `extractSimpleComparisons`: Extract simple AND-ed filters
+- `parseLoadSubsetOptions`: Convenience function to parse all options at once
+- `walkExpression`, `extractFieldPath`, `extractValue`: Lower-level helpers
+​
+**Example:**
+​
+```typescript
+import { parseLoadSubsetOptions } from "@tanstack/db"
+// or from "@tanstack/query-db-collection" (re-exported for convenience)
+​
+queryFn: async (ctx) => {
+ const { where, orderBy, limit } = ctx.meta.loadSubsetOptions
+​
+ const parsed = parseLoadSubsetOptions({ where, orderBy, limit })
+​
+ // Build API request from parsed filters