fix(query-core): allow function value of notifyOnChangeProps query …

…option to return `undefined` (#7441) * fix(query-core): allow function value of `notifyOnChangeProps` query option to return `undefined` `undefined` is a valid return value for the function value of `notifyOnChangeProps`. See linked issue for more details. Fixes #7426. * docs(react-query): update signature of `useQuery`'s `notifyOnChangeProps` option --------- Co-authored-by: Dominik Dorfmeister <[email protected]>
TanStack · Jul 18, 2024 · 0c671ee · 0c671ee
1 parent d02e610
commit 0c671ee
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/docs/framework/react/reference/useQuery.md b/docs/framework/react/reference/useQuery.md
@@ -130,7 +130,7 @@ const {
   - If set to `false`, the query will not refetch on reconnect.
   - If set to `"always"`, the query will always refetch on reconnect.
   - If set to a function, the function will be executed with the query to compute the value
-- `notifyOnChangeProps: string[] | "all" | (() => string[] | "all")`
+- `notifyOnChangeProps: string[] | "all" | (() => string[] | "all" | undefined)`
   - Optional
   - If set, the component will only re-render if any of the listed properties change.
   - If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.

diff --git a/packages/query-core/src/types.ts b/packages/query-core/src/types.ts
@@ -161,7 +161,8 @@ export type NetworkMode = 'online' | 'always' | 'offlineFirst'
 export type NotifyOnChangeProps =
   | Array<keyof InfiniteQueryObserverResult>
   | 'all'
-  | (() => Array<keyof InfiniteQueryObserverResult> | 'all')
+  | undefined
+  | (() => Array<keyof InfiniteQueryObserverResult> | 'all' | undefined)
 
 export interface QueryOptions<
   TQueryFnData = unknown,