How to change the default options for useQuery in react-query?

Question

I feel there are hints in the documentation about setting the default options for useQuery, but I cannot figure out exactly how. For example, the QueryClient takes a defaultOptions constructor but then it's not clear how to attach that to useQuery. Maybe it is not possible?

Do you want to change these options for specific queries or just all queries in general? — ivanatias
– ivanatias, Commented Oct 26, 2022 at 6:14
yeah I wish to change the global default behaviour of useQuery — Tom Larkworthy
– Tom Larkworthy, Commented Oct 27, 2022 at 9:33
Then doing so in the queryClient's defaultOptions is the way to go. These defaults will be used by all queries using that particular query client. — ivanatias
– ivanatias, Commented Oct 27, 2022 at 18:18

TkDodo · Accepted Answer · 2022-10-29 16:59:54Z

23

defaultOptions on the QueryClient will be applied to all queries, unless they have been specifically overwritten:

const queryClient = new QueryClient({
  defaultOptions: { queries: { staleTime: 5000 } },
})

if you want to set defaults for specific queries, you can do that with:

queryClient.setQueryDefaults(['todos'], { staleTime: 3000 })

answered Oct 29, 2022 at 16:59

TkDodo

30.4k5 gold badges85 silver badges100 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How to change the default options for useQuery in react-query?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related