refactor(infinite-queries): rename defaultPageParam to initialPageParam (#5888)

Moshyfawn · web-flow · commit 3aa068070751 · 2023-08-20T08:38:21.000+02:00
* refactor(query-core): rename defaultPageParam to initialPageParam Closes: #5885 * test(query-core): rename defaultPageParam to initialPageParam * test(react-query): rename defaultPageParam to initialPageParam * test(solid-query): rename defaultPageParam to initialPageParam * test(vue-query): rename defaultPageParam to initialPageParam * build(codemods): rename defaultPageParam to initialPageParam * docs(react-query, examples): rename defaultPageParam to initialPageParam * docs(react-query): rename defaultPageParam to initialPageParam * docs(svelte-query, examples): rename defaultPageParam to initialPageParam
diff --git a/docs/react/guides/infinite-queries.md b/docs/react/guides/infinite-queries.md
@@ -11,7 +11,7 @@ When using `useInfiniteQuery`, you'll notice a few things are different:
 - `data.pages` array containing the fetched pages
 - `data.pageParams` array containing the page params used to fetch the pages
 - The `fetchNextPage` and `fetchPreviousPage` functions are now available (`fetchNextPage` is required)
-- The `defaultPageParam` option is now available (and required) to specify the initial page param
+- The `initialPageParam` option is now available (and required) to specify the initial page param
 - The `getNextPageParam` and `getPreviousPageParam` options are available for both determining if there is more data to load and the information to fetch it. This information is supplied as an additional parameter in the query function
 - A `hasNextPage` boolean is now available and is `true` if `getNextPageParam` returns a value other than `null` or `undefined`
 - A `hasPreviousPage` boolean is now available and is `true` if `getPreviousPageParam` returns a value other than `null` or `undefined`
@@ -62,7 +62,7 @@ function Projects() {
   } = useInfiniteQuery({
     queryKey: ['projects'],
     queryFn: fetchProjects,
-    defaultPageParam: 0,
+    initialPageParam: 0,
     getNextPageParam: (lastPage, pages) => lastPage.nextCursor,
   })
 
@@ -113,7 +113,7 @@ Bi-directional lists can be implemented by using the `getPreviousPageParam`, `fe
 useInfiniteQuery({
   queryKey: ['projects'],
   queryFn: fetchProjects,
-  defaultPageParam: 0,
+  initialPageParam: 0,
   getNextPageParam: (lastPage, pages) => lastPage.nextCursor,
   getPreviousPageParam: (firstPage, pages) => firstPage.prevCursor,
 })
@@ -208,7 +208,7 @@ In the following example only 3 pages are kept in the query data pages array. If
 useInfiniteQuery({
   queryKey: ['projects'],
   queryFn: fetchProjects,
-  defaultPageParam: 0,
+  initialPageParam: 0,
   getNextPageParam: (lastPage, pages) => lastPage.nextCursor,
   getPreviousPageParam: (firstPage, pages) => firstPage.prevCursor,
   maxPages: 3,
@@ -225,7 +225,7 @@ If your API doesn't return a cursor, you can use the `pageParam` as a cursor. Be
 return useInfiniteQuery({
   queryKey: ['projects'],
   queryFn: fetchProjects,
-  defaultPageParam: 0,
+  initialPageParam: 0,
   getNextPageParam: (lastPage, allPages, lastPageParam) => {
     if (lastPage.length === 0) {
         return undefined
diff --git a/docs/react/guides/migrating-to-v5.md b/docs/react/guides/migrating-to-v5.md
@@ -321,18 +321,18 @@ The options you can pass to dehydrate have been simplified. Queries and Mutation
 - dehydrateQueries?: boolean
 ```
 
-### Infinite queries now need a `defaultPageParam`
+### Infinite queries now need a `initialPageParam`
 
 Previously, we've passed `undefined` to the `queryFn` as `pageParam`, and you could assign a default value to the `pageParam` parameter in the `queryFn` function signature. This had the drawback of storing `undefined` in the `queryCache`, which is not serializable.
 
-Instead, you now have to pass an explicit `defaultPageParam` to the infinite query options. This will be used as the `pageParam` for the first page:
+Instead, you now have to pass an explicit `initialPageParam` to the infinite query options. This will be used as the `pageParam` for the first page:
 
 ```diff
 useInfiniteQuery({
    queryKey,
 -  queryFn: ({ pageParam = 0 }) => fetchSomething(pageParam),
 +  queryFn: ({ pageParam }) => fetchSomething(pageParam),
-+  defaultPageParam: 0,
++  initialPageParam: 0,
    getNextPageParam: (lastPage) => lastPage.next,
 })
 ```
diff --git a/docs/react/guides/prefetching.md b/docs/react/guides/prefetching.md
@@ -34,7 +34,7 @@ const prefetchTodos = async () => {
   await queryClient.prefetchInfiniteQuery({
     queryKey: ['projects'],
     queryFn: fetchProjects,
-    defaultPageParam: 0,
+    initialPageParam: 0,
     getNextPageParam: (lastPage, pages) => lastPage.nextCursor,
     pages: 3 // prefetch the first 3 pages
   })
diff --git a/docs/react/reference/useInfiniteQuery.md b/docs/react/reference/useInfiniteQuery.md
@@ -15,7 +15,7 @@ const {
 } = useInfiniteQuery({
   queryKey,
   queryFn: ({ pageParam }) => fetchPage(pageParam),
-  defaultPageParam: 1,
+  initialPageParam: 1,
   ...options,
   getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) =>
     lastPage.nextCursor,
@@ -33,7 +33,7 @@ The options for `useInfiniteQuery` are identical to the [`useQuery` hook](../ref
   - The function that the query will use to request data.
   - Receives a [QueryFunctionContext](../guides/query-functions#queryfunctioncontext)
   - Must return a promise that will either resolve data or throw an error.
-- `defaultPageParam: TPageParam`
+- `initialPageParam: TPageParam`
   - **Required**
   - The default page param to use when fetching the first page.
 - `getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => TPageParam | undefined | null`
diff --git a/examples/react/algolia/src/useAlgolia.ts b/examples/react/algolia/src/useAlgolia.ts
@@ -22,7 +22,7 @@ export default function useAlgolia<TData>({
     queryKey: ['algolia', indexName, query, hitsPerPage],
     queryFn: ({ pageParam }) =>
       search<TData>({ indexName, query, pageParam, hitsPerPage }),
-    defaultPageParam: 0,
+    initialPageParam: 0,
     getNextPageParam: (lastPage) => lastPage?.nextPage,
     staleTime,
     gcTime,
diff --git a/examples/react/infinite-query-with-max-pages/src/pages/index.js b/examples/react/infinite-query-with-max-pages/src/pages/index.js
@@ -35,7 +35,7 @@ function Example() {
       const res = await axios.get('/api/projects?cursor=' + pageParam)
       return res.data
     },
-    defaultPageParam: 0,
+    initialPageParam: 0,
     getPreviousPageParam: (firstPage) => firstPage.previousId ?? undefined,
     getNextPageParam: (lastPage) => lastPage.nextId ?? undefined,
     maxPages: 3,
diff --git a/examples/react/load-more-infinite-scroll/src/pages/index.js b/examples/react/load-more-infinite-scroll/src/pages/index.js
@@ -39,7 +39,7 @@ function Example() {
       const res = await axios.get('/api/projects?cursor=' + pageParam)
       return res.data
     },
-    defaultPageParam: 0,
+    initialPageParam: 0,
     getPreviousPageParam: (firstPage) => firstPage.previousId ?? undefined,
     getNextPageParam: (lastPage) => lastPage.nextId ?? undefined,
   })
diff --git a/examples/svelte/load-more-infinite-scroll/src/lib/LoadMore.svelte b/examples/svelte/load-more-infinite-scroll/src/lib/LoadMore.svelte
@@ -9,7 +9,7 @@
   const query = createInfiniteQuery({
     queryKey: ['planets'],
     queryFn: ({ pageParam }) => fetchPlanets({ pageParam }),
-    defaultPageParam: 1,
+    initialPageParam: 1,
     getNextPageParam: (lastPage) => {
       if (lastPage.next) {
         const nextUrl = new URLSearchParams(new URL(lastPage.next).search)
diff --git a/packages/codemods/src/v5/rename-properties/__testfixtures__/rename-cache-time.input.tsx b/packages/codemods/src/v5/rename-properties/__testfixtures__/rename-cache-time.input.tsx
@@ -35,7 +35,7 @@ export function useAlgolia<TData>({
     queryKey: ['algolia', indexName, query, hitsPerPage],
     queryFn: ({ pageParam }) =>
       search<TData>({ indexName, query, pageParam, hitsPerPage }),
-    defaultPageParam: 0,
+    initialPageParam: 0,
     getNextPageParam: (lastPage) => lastPage?.nextPage,
     staleTime,
     cacheTime,
diff --git a/packages/codemods/src/v5/rename-properties/__testfixtures__/rename-cache-time.output.tsx b/packages/codemods/src/v5/rename-properties/__testfixtures__/rename-cache-time.output.tsx
@@ -35,7 +35,7 @@ export function useAlgolia<TData>({
     queryKey: ['algolia', indexName, query, hitsPerPage],
     queryFn: ({ pageParam }) =>
       search<TData>({ indexName, query, pageParam, hitsPerPage }),
-    defaultPageParam: 0,
+    initialPageParam: 0,
     getNextPageParam: (lastPage) => lastPage?.nextPage,
     staleTime,
     gcTime,
diff --git a/packages/query-core/src/infiniteQueryBehavior.ts b/packages/query-core/src/infiniteQueryBehavior.ts
@@ -100,7 +100,7 @@ export function infiniteQueryBehavior<TQueryFnData, TError, TData, TPageParam>(
           // Fetch first page
           result = await fetchPage(
             empty,
-            oldPageParams[0] ?? options.defaultPageParam,
+            oldPageParams[0] ?? options.initialPageParam,
           )
 
           const remainingPages = pages ?? oldPages.length
diff --git a/packages/query-core/src/tests/infiniteQueryBehavior.test.tsx b/packages/query-core/src/tests/infiniteQueryBehavior.test.tsx
@@ -24,7 +24,7 @@ describe('InfiniteQueryBehavior', () => {
     const observer = new InfiniteQueryObserver(queryClient, {
       queryKey: key,
       retry: false,
-      defaultPageParam: 1,
+      initialPageParam: 1,
       getNextPageParam: () => 2,
     })
 
@@ -62,7 +62,7 @@ describe('InfiniteQueryBehavior', () => {
       getNextPageParam: (lastPage) => lastPage + 1,
       getPreviousPageParam: (firstPage) => firstPage - 1,
       maxPages: 2,
-      defaultPageParam: 1,
+      initialPageParam: 1,
     })
 
     let observerResult:
@@ -204,7 +204,7 @@ describe('InfiniteQueryBehavior', () => {
       queryFn: queryFnSpy,
       getNextPageParam: (lastPage) => lastPage + 1,
       getPreviousPageParam: (firstPage) => firstPage - 1,
-      defaultPageParam: 1,
+      initialPageParam: 1,
     })
 
     let observerResult:
@@ -255,7 +255,7 @@ describe('InfiniteQueryBehavior', () => {
       queryFn: queryFnSpy,
       getNextPageParam: (lastPage) => lastPage + 1,
       getPreviousPageParam: (firstPage) => firstPage - 1,
-      defaultPageParam: 1,
+      initialPageParam: 1,
     })
 
     let observerResult:
diff --git a/packages/query-core/src/tests/infiniteQueryObserver.test.tsx b/packages/query-core/src/tests/infiniteQueryObserver.test.tsx
@@ -24,7 +24,7 @@ describe('InfiniteQueryObserver', () => {
         pages: data.pages.map((x) => `${x}`),
         pageParams: data.pageParams,
       }),
-      defaultPageParam: 1,
+      initialPageParam: 1,
       getNextPageParam: () => 2,
     })
     let observerResult
@@ -53,7 +53,7 @@ describe('InfiniteQueryObserver', () => {
         pages: data.pages.map((x) => `${x}`),
         pageParams: data.pageParams,
       }),
-      defaultPageParam: 1,
+      initialPageParam: 1,
       getNextPageParam: () => 2,
     })
     let observerResult
@@ -75,7 +75,7 @@ describe('InfiniteQueryObserver', () => {
     const observer = new InfiniteQueryObserver(queryClient, {
       queryKey: key,
       queryFn: ({ pageParam }) => String(pageParam),
-      defaultPageParam: 1,
+      initialPageParam: 1,
       getNextPageParam: (_, __, lastPageParam, allPageParams) => {
         single.push('next' + lastPageParam)
         all.push('next' + allPageParams.join(','))
@@ -110,7 +110,7 @@ describe('InfiniteQueryObserver', () => {
     const observer = new InfiniteQueryObserver(queryClient, {
       queryKey: key,
       queryFn,
-      defaultPageParam: 1,
+      initialPageParam: 1,
       getNextPageParam: () => next,
     })
 
@@ -137,7 +137,7 @@ describe('InfiniteQueryObserver', () => {
     const observer = new InfiniteQueryObserver(queryClient, {
       queryKey: key,
       queryFn,
-      defaultPageParam: 1,
+      initialPageParam: 1,
       getNextPageParam: () => next,
     })
 
diff --git a/packages/query-core/src/tests/queryClient.test.tsx b/packages/query-core/src/tests/queryClient.test.tsx
@@ -584,15 +584,15 @@ describe('queryClient', () => {
           StrictData,
           StrictQueryKey,
           number
-        >({ queryKey: key, queryFn: fetchFn, defaultPageParam: 0 }),
+        >({ queryKey: key, queryFn: fetchFn, initialPageParam: 0 }),
       ).resolves.toEqual(data)
     })
 
     test('should return infinite query data', async () => {
       const key = queryKey()
       const result = await queryClient.fetchInfiniteQuery({
         queryKey: key,
-        defaultPageParam: 10,
+        initialPageParam: 10,
         queryFn: ({ pageParam }) => Number(pageParam),
       })
       const result2 = queryClient.getQueryData(key)
@@ -622,7 +622,7 @@ describe('queryClient', () => {
         StrictData,
         StrictQueryKey,
         number
-      >({ queryKey: key, queryFn: fetchFn, defaultPageParam: 0 })
+      >({ queryKey: key, queryFn: fetchFn, initialPageParam: 0 })
 
       const result = queryClient.getQueryData(key)
 
@@ -638,7 +638,7 @@ describe('queryClient', () => {
       await queryClient.prefetchInfiniteQuery({
         queryKey: key,
         queryFn: ({ pageParam }) => Number(pageParam),
-        defaultPageParam: 10,
+        initialPageParam: 10,
       })
 
       const result = queryClient.getQueryData(key)
@@ -657,7 +657,7 @@ describe('queryClient', () => {
         queryFn: ({ pageParam }) => String(pageParam),
         getNextPageParam: (_lastPage, _pages, lastPageParam) =>
           lastPageParam + 5,
-        defaultPageParam: 10,
+        initialPageParam: 10,
         pages: 3,
       })
 
@@ -677,7 +677,7 @@ describe('queryClient', () => {
         queryFn: ({ pageParam }) => String(pageParam),
         getNextPageParam: (_lastPage, _pages, lastPageParam) =>
           lastPageParam >= 20 ? undefined : lastPageParam + 5,
-        defaultPageParam: 10,
+        initialPageParam: 10,
         pages: 5,
       })
 
diff --git a/packages/query-core/src/types.ts b/packages/query-core/src/types.ts
@@ -144,14 +144,14 @@ export interface QueryOptions<
   maxPages?: number
 }
 
-export interface DefaultPageParam<TPageParam = unknown> {
-  defaultPageParam: TPageParam
+export interface InitialPageParam<TPageParam = unknown> {
+  initialPageParam: TPageParam
 }
 
 export interface InfiniteQueryPageParamsOptions<
   TQueryFnData = unknown,
   TPageParam = unknown,
-> extends DefaultPageParam<TPageParam> {
+> extends InitialPageParam<TPageParam> {
   /**
    * This function can be set to automatically get the previous cursor for infinite queries.
    * The result will also be used to determine the value of `hasPreviousPage`.
@@ -384,7 +384,7 @@ export type FetchInfiniteQueryOptions<
   TQueryKey,
   TPageParam
 > &
-  DefaultPageParam<TPageParam> &
+  InitialPageParam<TPageParam> &
   FetchInfiniteQueryPages<TQueryFnData, TPageParam>
 
 export interface ResultOptions {
diff --git a/packages/react-query/src/__tests__/ssr.test.tsx b/packages/react-query/src/__tests__/ssr.test.tsx
@@ -132,7 +132,7 @@ describe('Server Side Rendering', () => {
         queryKey: key,
         queryFn,
         getNextPageParam: () => undefined,
-        defaultPageParam: 0,
+        initialPageParam: 0,
       })
       return (
         <ul>
@@ -146,7 +146,7 @@ describe('Server Side Rendering', () => {
     await queryClient.prefetchInfiniteQuery({
       queryKey: key,
       queryFn,
-      defaultPageParam: 0,
+      initialPageParam: 0,
     })
 
     const markup = renderToString(
diff --git a/packages/react-query/src/__tests__/suspense.test.tsx b/packages/react-query/src/__tests__/suspense.test.tsx
@@ -82,7 +82,7 @@ describe('useSuspenseQuery', () => {
           await sleep(10)
           return Number(pageParam * multiplier)
         },
-        defaultPageParam: 1,
+        initialPageParam: 1,
         getNextPageParam: (lastPage) => lastPage + 1,
       })
       states.push(state)
diff --git a/packages/react-query/src/__tests__/useInfiniteQuery.test.tsx b/packages/react-query/src/__tests__/useInfiniteQuery.test.tsx
diff --git a/packages/react-query/src/__tests__/useInfiniteQuery.type.test.tsx b/packages/react-query/src/__tests__/useInfiniteQuery.type.test.tsx
diff --git a/packages/solid-query/src/__tests__/createInfiniteQuery.test.tsx b/packages/solid-query/src/__tests__/createInfiniteQuery.test.tsx
diff --git a/packages/solid-query/src/__tests__/suspense.test.tsx b/packages/solid-query/src/__tests__/suspense.test.tsx
diff --git a/packages/vue-query/src/__tests__/queryClient.test.ts b/packages/vue-query/src/__tests__/queryClient.test.ts
diff --git a/packages/vue-query/src/__tests__/useInfiniteQuery.test.ts b/packages/vue-query/src/__tests__/useInfiniteQuery.test.ts
diff --git a/packages/vue-query/src/__tests__/useInfiniteQuery.types.test.tsx b/packages/vue-query/src/__tests__/useInfiniteQuery.types.test.tsx
