queryOptions()

Generates TanStack Query options for GET requests.

Signature

treaty.path.to.route.queryOptions(
  params?: EdenParams,
  options?: QueryOptions
): UseQueryOptions

Parameters

params (optional)

Eden Treaty request parameters:

{
  query?: Record<string, unknown>  // Query string parameters
  headers?: Record<string, string> // HTTP headers
}

options (optional)

TanStack Query options to override:

{
  staleTime?: number
  gcTime?: number
  enabled?: boolean
  refetchOnWindowFocus?: boolean
  refetchInterval?: number
  select?: (data: TData) => TSelected
  // ... all UseQueryOptions
}

Returns

A UseQueryOptions object compatible with useQuery, useSuspenseQuery, and prefetchQuery.

Examples

Basic

const { data } = useQuery(treaty.api.users.queryOptions())

With Query Parameters

const { data } = useQuery(
  treaty.api.users.queryOptions({
    query: { role: 'admin', limit: 10 }
  })
)

With Route Parameters

const { data } = useQuery(
  treaty.api.users({ id: userId }).queryOptions()
)

With TanStack Query Options

const { data } = useQuery(
  treaty.api.users.queryOptions(undefined, {
    staleTime: 5 * 60 * 1000,
    enabled: !!userId,
    select: (data) => data.filter(u => u.active)
  })
)

With Suspense

const { data } = useSuspenseQuery(
  treaty.api.users.queryOptions()
)

Prefetching

await queryClient.prefetchQuery(
  treaty.api.users.queryOptions()
)