fix(query-core): allow function value of `notifyOnChangeProps` query option to return `undefined` #7441

winghouchan · 2024-05-16T08:58:21Z

undefined is a valid return value for the function value of notifyOnChangeProps. See linked issue for more details.

vercel · 2024-05-16T08:58:25Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
query	⬜️ Ignored (Inspect)	Visit Preview		Jun 8, 2024 5:42pm

codesandbox-ci · 2024-05-16T09:00:35Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit e28ea02:

Sandbox	Source
@tanstack/query-example-angular-basic	Configuration
@tanstack/query-example-react-basic-typescript	Configuration
@tanstack/query-example-solid-basic-typescript	Configuration
@tanstack/query-example-svelte-basic	Configuration
@tanstack/query-example-vue-basic	Configuration

TkDodo · 2024-05-16T09:51:52Z

can you amend the signature in the docs as well please?

nx-cloud · 2024-05-16T09:52:03Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 76abb16. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 2 targets

Sent with 💌 from NxCloud.

TkDodo · 2024-05-16T09:52:50Z

also the jsdoc please:

query/packages/query-core/src/types.ts

Lines 319 to 326 in 3a8c2b1

    
             /** 
        
              * If set, the component will only re-render if any of the listed properties change. 
        
              * When set to `['data', 'error']`, the component will only re-render when the `data` or `error` properties change. 
        
              * When set to `'all'`, the component will re-render whenever a query is updated. 
        
              * When set to a function, the function will be executed to compute the list of properties. 
        
              * By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change. 
        
              */ 
        
             notifyOnChangeProps?: NotifyOnChangeProps

TkDodo · 2024-07-17T14:32:22Z

@winghouchan will you get this PR over the finish line or should I do it?

pkg-pr-new · 2024-07-17T14:34:50Z

Run & review this pull request in StackBlitz Codeflow.

commit: 76abb16

@tanstack/angular-query-devtools-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-devtools-experimental@7441

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@7441

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@7441

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@7441

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@7441

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@7441

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@7441

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@7441

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@7441

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@7441

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@7441

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@7441

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@7441

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@7441

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@7441

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@7441

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@7441

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@7441

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@7441

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@7441

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@7441

templates

codecov · 2024-07-17T14:37:40Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.33%. Comparing base (a87c2fe) to head (22c3569).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##           main    #7441       +/-   ##
=========================================
+ Coverage      0   63.33%   +63.33%     
=========================================
  Files         0      125      +125     
  Lines         0     4522     +4522     
  Branches      0     1259     +1259     
=========================================
+ Hits          0     2864     +2864     
- Misses        0     1430     +1430     
- Partials      0      228      +228

Components	Coverage Δ
@tanstack/angular-query-devtools-experimental	`∅ <ø> (∅)`
@tanstack/angular-query-experimental	`86.58% <ø> (∅)`
@tanstack/eslint-plugin-query	`∅ <ø> (∅)`
@tanstack/query-async-storage-persister	`43.85% <ø> (∅)`
@tanstack/query-broadcast-client-experimental	`∅ <ø> (∅)`
@tanstack/query-codemods	`∅ <ø> (∅)`
@tanstack/query-core	`92.87% <ø> (∅)`
@tanstack/query-devtools	`5.24% <ø> (∅)`
@tanstack/query-persist-client-core	`57.73% <ø> (∅)`
@tanstack/query-sync-storage-persister	`82.50% <ø> (∅)`
@tanstack/react-query	`92.98% <ø> (∅)`
@tanstack/react-query-devtools	`10.71% <ø> (∅)`
@tanstack/react-query-next-experimental	`∅ <ø> (∅)`
@tanstack/react-query-persist-client	`100.00% <ø> (∅)`
@tanstack/solid-query	`78.06% <ø> (∅)`
@tanstack/solid-query-devtools	`∅ <ø> (∅)`
@tanstack/solid-query-persist-client	`100.00% <ø> (∅)`
@tanstack/svelte-query	`90.00% <ø> (∅)`
@tanstack/svelte-query-devtools	`∅ <ø> (∅)`
@tanstack/svelte-query-persist-client	`100.00% <ø> (∅)`
@tanstack/vue-query	`71.42% <ø> (∅)`
@tanstack/vue-query-devtools	`∅ <ø> (∅)`

…option to return `undefined` `undefined` is a valid return value for the function value of `notifyOnChangeProps`. See linked issue for more details. Fixes TanStack#7426.

…ops` option

winghouchan · 2024-07-17T18:24:02Z

@TkDodo: sorry, missed your messages.

I've updated the signature in documentation in 43f0722. As far as I can tell it only affects React (and Vue, although they share the same docs). Please let me know if this is incorrect.

How would you like the JSDoc updated? The current description isn't wrong, although I suppose it could be improved. Maybe something like below:

If set to a function, the function will be executed to compute the list of properties.

If the value is set or computed to undefined, access to properties will be tracked, and the component will only re-render when one of the tracked properties change. This is the default behaviour.

If the value is set or computed to an array, the component will only re-render if any of the listed properties change. For example, if the value is set to or computed to ['data', 'error'], the component will only re-render when the data or error properties change.

If the value is set or computed to "all", the component will opt-out of smart tracking and re-render whenever a query is updated.

github-actions bot added the package: query-core label May 16, 2024

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

0931abd

…option to return `undefined` `undefined` is a valid return value for the function value of `notifyOnChangeProps`. See linked issue for more details. Fixes TanStack#7426.

winghouchan force-pushed the main branch from 22c3569 to 0931abd Compare July 17, 2024 17:43

docs(react-query): update signature of useQuery's `notifyOnChangePr…

43f0722

…ops` option

github-actions bot added the documentation Improvements or additions to documentation label Jul 17, 2024

Merge branch 'main' into main

76abb16

TkDodo merged commit 0c671ee into TanStack:main Jul 18, 2024
5 checks passed

dn54321 mentioned this pull request Aug 8, 2024

[Snyk] Upgrade @tanstack/react-query-devtools from 5.50.1 to 5.51.9 dn54321/Weaget#3

Closed

mostafatamer11 mentioned this pull request Aug 9, 2024

[Snyk] Upgrade @tanstack/react-query from 5.51.1 to 5.51.9 mostafatamer11/react-django-demo#5

Open

mariush2 mentioned this pull request Aug 11, 2024

[Snyk] Upgrade @tanstack/react-query from 5.51.9 to 5.51.11 equinor/amplify-component-lib#692

Closed

zntb mentioned this pull request Aug 11, 2024

[Snyk] Upgrade @tanstack/react-query-persist-client from 5.51.9 to 5.51.11 zntb/crypto-ticker#24

Merged

davidfrey mentioned this pull request Aug 11, 2024

[Snyk] Upgrade @tanstack/react-query from 5.51.9 to 5.51.11 davidfrey/yautja#2

Merged

dn54321 mentioned this pull request Aug 11, 2024

[Snyk] Upgrade @tanstack/react-query-devtools from 5.50.1 to 5.51.11 dn54321/Weaget#4

Closed

This was referenced Aug 12, 2024

[Snyk] Upgrade @tanstack/react-query from 5.29.2 to 5.51.11 ZeroXClem/cohere-toolkit#4

Closed

[Snyk] Upgrade @tanstack/react-query-devtools from 5.29.2 to 5.51.11 ZeroXClem/cohere-toolkit#5

Closed

MTthoas mentioned this pull request Aug 13, 2024

[Snyk] Upgrade @tanstack/react-query from 5.51.9 to 5.51.11 MTthoas/Dex#197

Open

This was referenced Aug 16, 2024

[Snyk] Upgrade @tanstack/react-query from 5.17.1 to 5.51.11 zntb/ReactEvents-With-TanStack-Query#6

Merged

[Snyk] Upgrade @tanstack/query-sync-storage-persister from 5.51.9 to 5.51.14 zntb/crypto-ticker#26

Merged

davidfrey mentioned this pull request Aug 16, 2024

[Snyk] Upgrade @tanstack/react-query from 5.51.9 to 5.51.14 davidfrey/yautja#4

Merged

atogura mentioned this pull request Aug 16, 2024

[Snyk] Upgrade @tanstack/angular-query-experimental from 5.15.2 to 5.51.14 atogura/angular-challenges#6

Open

dn54321 mentioned this pull request Aug 16, 2024

[Snyk] Upgrade @tanstack/react-query-devtools from 5.50.1 to 5.51.14 dn54321/Weaget#5

Closed

davidfrey mentioned this pull request Aug 18, 2024

[Snyk] Upgrade @tanstack/react-query from 5.51.9 to 5.51.15 davidfrey/yautja#5

Merged

zntb mentioned this pull request Aug 19, 2024

[Snyk] Upgrade @tanstack/react-query from 5.51.1 to 5.51.15 zntb/nextjs-web3-app-zksync#18

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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` #7441

winghouchan commented May 16, 2024

vercel bot commented May 16, 2024 •

edited

Loading

codesandbox-ci bot commented May 16, 2024 •

edited

Loading

TkDodo commented May 16, 2024

nx-cloud bot commented May 16, 2024 •

edited

Loading

TkDodo commented May 16, 2024

TkDodo commented Jul 17, 2024

pkg-pr-new bot commented Jul 17, 2024 •

edited

Loading

codecov bot commented Jul 17, 2024

winghouchan commented Jul 17, 2024

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 #7441

Conversation

winghouchan commented May 16, 2024

vercel bot commented May 16, 2024 • edited Loading

codesandbox-ci bot commented May 16, 2024 • edited Loading

TkDodo commented May 16, 2024

nx-cloud bot commented May 16, 2024 • edited Loading

☁️ Nx Cloud Report

TkDodo commented May 16, 2024

TkDodo commented Jul 17, 2024

pkg-pr-new bot commented Jul 17, 2024 • edited Loading

codecov bot commented Jul 17, 2024

Codecov Report

winghouchan commented Jul 17, 2024

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` #7441

vercel bot commented May 16, 2024 •

edited

Loading

codesandbox-ci bot commented May 16, 2024 •

edited

Loading

nx-cloud bot commented May 16, 2024 •

edited

Loading

pkg-pr-new bot commented Jul 17, 2024 •

edited

Loading