Skip to content

Commit 3896f0d

Browse files
author
Alexandre Da Costa
authored
docs: Add missing isStale in api.md (TanStack#784)
1 parent b01d269 commit 3896f0d

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/src/pages/docs/api.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ const {
1414
isError,
1515
data,
1616
error,
17+
isStale,
1718
isFetching,
1819
failureCount,
1920
refetch,
@@ -142,6 +143,8 @@ const queryInfo = useQuery({
142143
- `error: null | Error`
143144
- Defaults to `null`
144145
- The error object for the query, if an error was thrown.
146+
- `isStale: Boolean`
147+
- Will be `true` if the cache data is stale.
145148
- `isFetching: Boolean`
146149
- Defaults to `true` so long as `manual` is set to `false`
147150
- Will be `true` if the query is currently fetching, including background fetching.

0 commit comments

Comments
 (0)