Update docs to avoid circular type

reduxjs · Dec 5, 2023 · 3ffa3a6 · 3ffa3a6
1 parent cf29e62
commit 3ffa3a6
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 8 deletions.
diff --git a/docs/rtk-query/usage/persistence-and-rehydration.mdx b/docs/rtk-query/usage/persistence-and-rehydration.mdx
@@ -43,22 +43,27 @@ import { REHYDRATE } from 'redux-persist'
 
 type RootState = any // normally inferred from state
 
-function isHydrateAction(action: Action): action is PayloadAction<RootState> {
+function isHydrateAction(action: Action): action is Action<typeof REHYDRATE> & {
+  key: string
+  payload: RootState
+  err: unknown
+} {
   return action.type === REHYDRATE
 }
 
 export const api = createApi({
   baseQuery: fetchBaseQuery({ baseUrl: '/' }),
   // highlight-start
-  extractRehydrationInfo(action, { reducerPath }) {
+  // to prevent circular type issues, the return type needs to be annotated as any
+  extractRehydrationInfo(action, { reducerPath }): any {
     if (isHydrateAction(action)) {
-      if ((action as any).key === 'key used with redux-persist') {
-        // when persisting the api reducer
+      // when persisting the api reducer
+      if (action.key === 'key used with redux-persist') {
         return action.payload
       }
 
       // When persisting the root reducer
-      return action.payload[reducerPath]
+      return action.payload[api.reducerPath]
     }
   },
   // highlight-end

diff --git a/packages/toolkit/src/query/createApi.ts b/packages/toolkit/src/query/createApi.ts
@@ -175,14 +175,18 @@ export interface CreateApiOptions<
    *
    * type RootState = any; // normally inferred from state
    *
-   * function isHydrateAction(action: Action): action is PayloadAction<RootState> {
-   *   return action.type === HYDRATE
+   * function isHydrateAction(action: Action): action is Action<typeof REHYDRATE> & {
+   *   key: string
+   *   payload: RootState
+   *   err: unknown
+   * } {
+   *   return action.type === REHYDRATE
    * }
    *
    * export const api = createApi({
    *   baseQuery: fetchBaseQuery({ baseUrl: '/' }),
    *   // highlight-start
-   *   extractRehydrationInfo(action, { reducerPath }) {
+   *   extractRehydrationInfo(action, { reducerPath }): any {
    *     if (isHydrateAction(action)) {
    *       return action.payload[reducerPath]
    *     }