Fix infiniteQueryOptions example compilation

reduxjs · Jan 20, 2025 · 46c922a · 46c922a
1 parent f5aaa4f
commit 46c922a
Showing 1 changed file with 30 additions and 25 deletions.
diff --git a/packages/toolkit/src/query/endpointDefinitions.ts b/packages/toolkit/src/query/endpointDefinitions.ts
@@ -618,33 +618,38 @@ export interface InfiniteQueryExtraOptions<
    * 
    * ```ts
    * // codeblock-meta title="infiniteQueryOptions example"
-   * getInfinitePokemonWithMax: build.infiniteQuery<
-        Pokemon[],
-        string,
-        number
-      >({
-        infiniteQueryOptions: {
-          initialPageParam: 0,
-          maxPages: 3,
-          getNextPageParam: (
-            lastPage,
-            allPages,
-            lastPageParam,
-            allPageParams,
-          ) => lastPageParam + 1,
-          getPreviousPageParam: (
-            firstPage,
-            allPages,
-            firstPageParam,
-            allPageParams,
-          ) => {
-            return firstPageParam > 0 ? firstPageParam - 1 : undefined
+   * import { createApi, fetchBaseQuery, defaultSerializeQueryArgs } from '@reduxjs/toolkit/query/react'
+   * 
+   * type Pokemon = {
+   *   id: string
+   *   name: string
+   * }
+   * 
+    const pokemonApi = createApi({
+      baseQuery: fetchBaseQuery({ baseUrl: 'https://pokeapi.co/api/v2/' }),
+      endpoints: (build) => ({
+        getInfinitePokemonWithMax: build.infiniteQuery<Pokemon[], string, number>({
+          infiniteQueryOptions: {
+            initialPageParam: 0,
+            maxPages: 3,
+            getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) =>
+              lastPageParam + 1,
+            getPreviousPageParam: (
+              firstPage,
+              allPages,
+              firstPageParam,
+              allPageParams,
+            ) => {
+              return firstPageParam > 0 ? firstPageParam - 1 : undefined
+            },
+          },
+          query(pageParam) {
+            return `https://example.com/listItems?page=${pageParam}`
           },
-        },
-        query(pageParam) {
-          return `https://example.com/listItems?page=${pageParam}`
-        },
+        }),
       }),
+    })
+   
    * ```
    */
   infiniteQueryOptions: InfiniteQueryConfigOptions<ResultType, PageParam>