Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

useIsRestoring.md

20 lines622 Bytes

1---
2id: useIsRestoring
3title: useIsRestoring
4---
5​
6```ts
7function useIsRestoring(): boolean;
8```
9​
10Defined in: [packages/react-query/src/IsRestoringProvider.ts:12](https://github.com/TanStack/query/blob/main/packages/react-query/src/IsRestoringProvider.ts#L12)
11​
12If you are using `PersistQueryClientProvider`, you can also use the `useIsRestoring` hook alongside it to
13check if a restore is currently in progress. `useQuery` and friends also check this internally to avoid
14race conditions between the restore and mounting queries.
15​
16## Returns
17​
18`boolean`
19​
20`true` while a persisted client is being restored, `false` otherwise.