eden2query 0.1.0 → 0.1.1

package/README.md

@@ -17,10 +17,10 @@ import type { App } from "./server"; // your Elysia app type
 
 const client = treaty<App>("localhost:3000");
 
-// GET → queryOptions
+// GET → queryOptions (fn is a thunk that calls the Eden GET function)
 const resourceQuery = treatyQueryOptions({
   queryKey: ["resource"],
-  fn: client.api.resource.get,
+  fn: () => client.api.resource.get({ query: { q: "hello" } }),
 });
 
 // POST / PUT / DELETE → mutationOptions
@@ -43,14 +43,19 @@ const mutation = useMutation(createResource);
 mutation.mutate({ name: "New item" }); // fully typed input
 ```
 
-Works with `prefetchQuery`, `ensureQueryData`, `useSuspenseQuery`, etc.
+Works with `prefetchQuery`, `ensureQueryData`, `useSuspenseQuery`, etc:
+
+```ts
+const queryClient = new QueryClient();
+await queryClient.prefetchQuery(resourceQuery);
+```
 
 You can also pass any standard React Query options alongside `fn`:
 
 ```ts
 const resourceQuery = treatyQueryOptions({
   queryKey: ["resource"],
-  fn: client.api.resource.get,
+  fn: () => client.api.resource.get({ query: { q: "hello" } }),
   refetchInterval: 1000,
 });
 
@@ -62,7 +67,7 @@ const createResource = treatyMutationOptions({
 
 ## API
 
-**`treatyQueryOptions({ queryKey, fn, ...queryOptions })`** — wraps an Eden GET function into `queryOptions`. Accepts all `queryOptions` fields except `queryFn`. Extracts `data` from the response and throws on `error`.
+**`treatyQueryOptions({ queryKey, fn, ...queryOptions })`** — wraps an Eden GET call into `queryOptions`. `fn` is a **thunk** (zero-argument function) that calls the Eden GET function, e.g. `() => client.api.resource.get({ query: { ... } })`. This lets you bind query parameters, headers, or any other Eden options at definition time. Accepts all `queryOptions` fields except `queryFn`. Extracts `data` from the response and throws on `error`.
 
 **`treatyMutationOptions({ fn, ...mutationOptions })`** — wraps an Eden mutation function into `mutationOptions`. Accepts all `mutationOptions` fields except `mutationFn` (e.g. `onSuccess`, `onSettled`, `onMutate`). The `mutate` call accepts the same input the Eden function expects.