Use ensureQueryData with invalidations

[samiBendou]

Hello everyone,

I had to use ensureQueryData in order to retrieve some query data that might already be cached. The data should be fresh, so I might have to use fetchQuery if the query data has been invalidated (or stale btw).

To solve this issue I came with this function that have the expected behavior :

async function ensureFreshQueryData<
  TQueryFnData,
  TError,
  TData,
  TQueryKey extends QueryKey = QueryKey
>(
  queryClient: QueryClient,
  query: WithRequired<
    FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
    "queryKey"
  >
): Promise<any> {
  const state = queryClient.getQueryState(query.queryKey);
  const data = queryClient.getQueryData(query.queryKey);
  if (!state || state.isInvalidated || !data) {
    return await queryClient.fetchQuery(query);
  }

  return data;
}

I am not sure if this is the right way to do that. I would like to know if there is something simpler to do. If not I think that would be a good idea to integrate ensureFreshQueryData as a features of the queryClient.

Thanks a lot !

[TkDodo]

just use fetchQuery and pass a staleTime to it.

[samiBendou]

Wow that was fast, thank you ! 👍