0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/docs/framework/lit/reference/functions/keepPreviousData.md
Wonsuk Choi 6e16d3946a
docs(query-core/utils): add missing JSDoc to utility functions (#11830)
* docs(query-core/utils): add missing JSDoc to utility functions

* docs(query-core/utils): clarify that 'addToEnd' and 'addToStart' drop at most one item

* docs(framework/*/reference): regenerate reference docs
2026-10-04 02:47:14 +09:00

916 B

id title
keepPreviousData keepPreviousData
function keepPreviousData<T>(previousData: T | undefined): T | undefined;

Defined in: packages/query-core/src/utils.ts:576

Intended to be passed as a query's placeholderData option, for example placeholderData: keepPreviousData. Instead of resetting the query's data to undefined while a new query key is fetching, it keeps displaying the previously fetched data until the new data arrives.

Type Parameters

T

T

Parameters

previousData

The data of the previous query key, passed by the observer.

T | undefined

Returns

T | undefined

The previous data, unchanged.

Example

new QueryObserver(queryClient, {
  queryKey: ['posts', page],
  queryFn: () => fetchPosts(page),
  placeholderData: keepPreviousData,
})