stale option doesn't work in refetch method

[fhugoduarte]

Descrption

I would like to call my query imperatively. For that I passed the enable option as false and I'm using the refetch to execute the query.

The problem is that I want the refetch method to respect the staleTime, I'm trying to pass the stale option as true, but the request is fired anyway.

I would like to know if this is the expected behavior and how I could solve this problem.
Currently I'm passing enabled as a parameter to my query and controlling it with a state.

Evidence:

Screen.Recording.2022-11-02.at.16.50.03.mov

CodeSandBox example

[TkDodo]

Yes, this is the expected behaviour. refetch returned from useQuery is an unconditional fetch - the only thing that can bypass the enabled option. By doing this, you opt-out of most of the cool features that react-query offers, like respecting staleTime.

I would like to call my query imperatively. For that I passed the enable option as false and I'm using the refetch to execute the query.

I would argue that this is still not the right way to go about it in most cases. You can have queries be lazily evaluated with a dynamic enabled option. Have a look at lazy queries.

[GeorgeCht]

If anyone is still searching this check here

[fhugoduarte]

Ok, but the refetch function takes these parameters. I still don't understand why they exist, do they really work?
Wouldn't it be possible to add these kind of filters to the refetch?

[TkDodo]

Ok, but the refetch function takes these parameters. I still don't understand why they exist, do they really work?

not sure what you are talking about. refetch doesn't take any parameters. Are we talking about the same thing?

const { refetch } = useQuery(...)

// ⬇️ no parameters here!
refetch()

[fhugoduarte]

Does refetch not receive options params? CodeSandBox example

[TkDodo]

no, it takes:

throwOnError?: boolean
cancelRefetch?: boolean
refetchPage?: (
  lastPage: TPageData,
  index: number,
  allPages: TPageData[],
) => boolean

query/packages/query-core/src/queryObserver.ts

Lines 277 to 280 in 1614c31

	refetch<TPageData>({
	refetchPage,
	...options
	}: RefetchOptions & RefetchPageFilters<TPageData> = {}): Promise<

all of these are "options" that you'll rarely need, not filters.

The interesting thing is that in your sandbox, the type for refetch is shown as:

RefetchOptions & RefetchQueryFilters<unknown>

and the RefetchQueryFilters part is certainly wrong, so I think we have a typings bug here:

query/packages/query-core/src/types.ts

Lines 389 to 391 in 07c9631

	refetch: <TPageData>(
	options?: RefetchOptions & RefetchQueryFilters<TPageData>,
	) => Promise<QueryObserverResult<TData, TError>>

It should be RefetchPageFilters, not RefetchQueryFilters 😅 . Feel free to open an issue, or even better, a PR :)