Merge pull request #4000 from domvo/docs/correction-of-refetch-typing-for-use-query

EskiMojo14 · web-flow · commit 6c64f69b6176 · 2024-03-07T15:42:38.000Z
correction of the refetch function type in useQuery documentation
diff --git a/docs/rtk-query/api/created-api/hooks.mdx b/docs/rtk-query/api/created-api/hooks.mdx
@@ -277,7 +277,7 @@ type UseQueryResult<T> = {
   isSuccess: boolean // Query has data from a successful load.
   isError: boolean // Query is currently in an "error" state.
 
-  refetch: () => void // A function to force refetch the query
+  refetch: () => QueryActionCreatorResult // A function to force refetch the query - returns a Promise with additional methods
 }
 ```
 

Original file line number	Diff line number	Diff line change
`@@ -277,7 +277,7 @@ type UseQueryResult<T> = {`
`277`	`277`	`isSuccess: boolean // Query has data from a successful load.`
`278`	`278`	`isError: boolean // Query is currently in an "error" state.`
`279`	`279`
`280`		`- refetch: () => void // A function to force refetch the query`
	`280`	`+ refetch: () => QueryActionCreatorResult // A function to force refetch the query - returns a Promise with additional methods`
`281`	`281`	`}`
`282`	`282`	```
`283`	`283`