Source: https://tanstack.com/query/latest/docs/framework/solid/reference/queryOptions

TanStack

Query v5v5

Search...

+ K

Auto

Log In

TanStack StartRC

Docs Examples GitHub Contributors

TanStack Router

Docs Examples GitHub Contributors

TanStack Query

Docs Examples GitHub Contributors

TanStack Table

Docs Examples Github Contributors

TanStack Formnew

Docs Examples Github Contributors

TanStack DBbeta

Docs Github Contributors

TanStack Virtual

Docs Examples Github Contributors

TanStack Paceralpha

Docs Examples Github Contributors

TanStack Storealpha

Docs Examples Github Contributors

TanStack Devtoolsalpha

Docs Github Contributors

More Libraries

Maintainers Partners Support Learn StatsBETA Discord Merch Blog GitHub Ethos Brand Guide

Documentation

Framework

Solid

Version

Latest

Search...

+ K

Menu

• Home

• Frameworks

• Contributors

• Community Resources

• GitHub

• Discord

Getting Started

• Overview
  
  solid

• Quick Start
  
  solid

• Installation
  
  solid

• Devtools
  
  solid

• TypeScript
  
  solid

Guides & Concepts

• Important Defaults
  
  solid

• Queries
  
  solid

• Query Keys
  
  solid

• Query Functions
  
  solid

• Query Options
  
  solid

• Network Mode
  
  solid

• Parallel Queries
  
  solid

• Dependent Queries
  
  solid

• Background Fetching Indicators
  
  solid

• Window Focus Refetching
  
  solid

• Disabling/Pausing Queries
  
  solid

• Query Retries
  
  solid

• Paginated Queries
  
  solid

• Infinite Queries
  
  solid

• Initial Query Data
  
  solid

• Placeholder Query Data
  
  solid

• Mutations
  
  solid

• Query Invalidation
  
  solid

• Invalidation from Mutations
  
  solid

• Updates from Mutation Responses
  
  solid

• Optimistic Updates
  
  solid

• Query Cancellation
  
  solid

• Scroll Restoration
  
  solid

• Filters
  
  solid

• Request Waterfalls
  
  solid

• Prefetching
  
  solid

• SSR
  
  solid

• Advanced SSR
  
  solid

• Caching
  
  solid

• Default Query Fn
  
  solid

• Suspense
  
  solid

• Testing
  
  solid

• Does this replace state managers?
  
  solid

API Reference

• QueryClient
  
  core

• QueryCache
  
  core

• MutationCache
  
  core

• QueryObserver
  
  core

• InfiniteQueryObserver
  
  core

• QueriesObserver
  
  core

• streamedQuery
  
  core

• focusManager
  
  core

• onlineManager
  
  core

• notifyManager
  
  core

• timeoutManager
  
  core

• useQuery
  
  solid

• useQueries
  
  solid

• useInfiniteQuery
  
  solid

• useMutation
  
  solid

• useIsFetching
  
  solid

• useIsMutating
  
  solid

• useMutationState
  
  solid

• queryOptions
  
  solid

• infiniteQueryOptions
  
  solid

• hydration
  
  solid

ESLint

• ESLint Plugin Query
  
  core

• Exhaustive Deps
  
  core

• Stable Query Client
  
  core

• No Rest Destructuring
  
  core

• No Unstable Deps
  
  core

• Infinite Query Property Order
  
  core

Examples

• Simple
  
  solid

• Basic
  
  solid

• Basic w/ GraphQL-Request
  
  solid

• Default Query Function
  
  solid

• Solid Start
  
  solid

• Astro
  
  solid

Plugins

• broadcastQueryClient (Experimental)
  
  solid

• createPersister (Experimental)
  
  solid

Framework

Solid

Version

Latest

Menu

• Home

• Frameworks

• Contributors

• Community Resources

• GitHub

• Discord

Getting Started

• Overview
  
  solid

• Quick Start
  
  solid

• Installation
  
  solid

• Devtools
  
  solid

• TypeScript
  
  solid

Guides & Concepts

• Important Defaults
  
  solid

• Queries
  
  solid

• Query Keys
  
  solid

• Query Functions
  
  solid

• Query Options
  
  solid

• Network Mode
  
  solid

• Parallel Queries
  
  solid

• Dependent Queries
  
  solid

• Background Fetching Indicators
  
  solid

• Window Focus Refetching
  
  solid

• Disabling/Pausing Queries
  
  solid

• Query Retries
  
  solid

• Paginated Queries
  
  solid

• Infinite Queries
  
  solid

• Initial Query Data
  
  solid

• Placeholder Query Data
  
  solid

• Mutations
  
  solid

• Query Invalidation
  
  solid

• Invalidation from Mutations
  
  solid

• Updates from Mutation Responses
  
  solid

• Optimistic Updates
  
  solid

• Query Cancellation
  
  solid

• Scroll Restoration
  
  solid

• Filters
  
  solid

• Request Waterfalls
  
  solid

• Prefetching
  
  solid

• SSR
  
  solid

• Advanced SSR
  
  solid

• Caching
  
  solid

• Default Query Fn
  
  solid

• Suspense
  
  solid

• Testing
  
  solid

• Does this replace state managers?
  
  solid

API Reference

• QueryClient
  
  core

• QueryCache
  
  core

• MutationCache
  
  core

• QueryObserver
  
  core

• InfiniteQueryObserver
  
  core

• QueriesObserver
  
  core

• streamedQuery
  
  core

• focusManager
  
  core

• onlineManager
  
  core

• notifyManager
  
  core

• timeoutManager
  
  core

• useQuery
  
  solid

• useQueries
  
  solid

• useInfiniteQuery
  
  solid

• useMutation
  
  solid

• useIsFetching
  
  solid

• useIsMutating
  
  solid

• useMutationState
  
  solid

• queryOptions
  
  solid

• infiniteQueryOptions
  
  solid

• hydration
  
  solid

ESLint

• ESLint Plugin Query
  
  core

• Exhaustive Deps
  
  core

• Stable Query Client
  
  core

• No Rest Destructuring
  
  core

• No Unstable Deps
  
  core

• Infinite Query Property Order
  
  core

Examples

• Simple
  
  solid

• Basic
  
  solid

• Basic w/ GraphQL-Request
  
  solid

• Default Query Function
  
  solid

• Solid Start
  
  solid

• Astro
  
  solid

Plugins

• broadcastQueryClient (Experimental)
  
  solid

• createPersister (Experimental)
  
  solid

On this page

• Further reading

queryOptions

Copy Markdown

tsx

queryOptions({
  queryKey,
  ...options,
})


queryOptions({
  queryKey,
  ...options,
})

Options

You can generally pass everything to queryOptions that you can also pass to useQuery . Some options will have no effect when then forwarded to a function like queryClient.prefetchQuery, but TypeScript will still be fine with those excess properties.

• queryKey: QueryKey
  • Required
  • The query key to generate options for.
• experimental_prefetchInRender?: boolean
  • Optional
  • Defaults to false
  • When set to true, queries will be prefetched during render, which can be useful for certain optimization scenarios
  • Needs to be turned on for the experimental useQuery().promise functionality

Further reading
---------------

To learn more about QueryOptions, have a look at this article by TkDodo The Query Options API .

Edit on GitHub

useMutationState

infiniteQueryOptions

Partners Become a Partner

[###### Want to Skip the Docs?

Query.gg - The Official React Query Course
\

“If you’re serious about *really* understanding React Query, there’s no better way than with query.gg”—Tanner Linsley

Learn More](https://query.gg/?s=tanstack)