VexQueryOptions
VexQueryOptions<
TArgs,TReturn> =Pick<UseSuspenseQueryOptions<TReturn,Error,TReturn, ["convexQuery",FunctionReference<"query","public",TArgs,TReturn>,TArgs]>,"queryKey"|"queryFn"|"staleTime">
Defined in: packages/core/src/api/types.ts:516
Tanstack-query options as produced by convexQuery for a non-"skip" call,
with the result pinned to TReturn instead of the funcRef’s baked type.
Named deliberately: publishing this contract as ReturnType<typeof convexQuery> instantiates the adapter’s generics at their constraints and
collapses the query data to any.
Type Parameters
Section titled “Type Parameters”TArgs extends Record<string, unknown>
The endpoint’s args shape.
TReturn
Section titled “TReturn”TReturn
The narrowed return type for this call.