fix: deprecate direction passed to QueryFunctionContext

TanStack · May 10, 2024 · b9cc9e4 · b9cc9e4
1 parent 0bb0fa3
commit b9cc9e4
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/docs/framework/react/guides/query-functions.md b/docs/framework/react/guides/query-functions.md
@@ -111,4 +111,6 @@ Additionally, [Infinite Queries](../infinite-queries) get the following options
 - `pageParam: TPageParam`
   - the page parameter used to fetch the current page
 - `direction: 'forward' | 'backward'`
+  - **deprecated**
   - the direction of the current page fetch
+  - To get access to the direction of the current page fetch, please add a direction to `pageParam` from `getNextPageParam` and `getPreviousPageParam`.
diff --git a/packages/query-core/src/types.ts b/packages/query-core/src/types.ts
@@ -71,12 +71,20 @@ export type QueryFunctionContext<
       signal: AbortSignal
       meta: QueryMeta | undefined
       pageParam?: unknown
-      direction?: 'forward' | 'backward'
+      /**
+       * @deprecated
+       * if you want access to the direction, you can add it to the pageParam
+       */
+      direction?: unknown
     }
   : {
       queryKey: TQueryKey
       signal: AbortSignal
       pageParam: TPageParam
+      /**
+       * @deprecated
+       * if you want access to the direction, you can add it to the pageParam
+       */
       direction: FetchDirection
       meta: QueryMeta | undefined
     }