0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-18 19:33:22 +00:00
query/docs/framework/react/reference/functions/useIsRestoring.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

622 B

id title
useIsRestoring useIsRestoring
function useIsRestoring(): boolean;

Defined in: packages/react-query/src/IsRestoringProvider.ts:12

If you are using PersistQueryClientProvider, you can also use the useIsRestoring hook alongside it to check if a restore is currently in progress. useQuery and friends also check this internally to avoid race conditions between the restore and mounting queries.

Returns

boolean

true while a persisted client is being restored, false otherwise.