TanStack
API Reference

useIsRestoring

ts
function useIsRestoring(): Accessor<boolean>;

Defined in: isRestoring.ts:13

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

Accessor<boolean>

An accessor that reads true while a persisted client is being restored, false otherwise.