Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(react): update the react-native.md section #8506

Merged
merged 4 commits into from
Jan 8, 2025

Conversation

flodlc
Copy link
Contributor

@flodlc flodlc commented Jan 5, 2025

No description provided.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 5, 2025
Copy link

nx-cloud bot commented Jan 5, 2025

View your CI Pipeline Execution ↗ for commit 27d766e.

Command Status Duration Result
nx affected --targets=test:sherif,test:knip,tes... ✅ Succeeded 1m 37s View ↗
nx run-many --target=build --exclude=examples/*... ✅ Succeeded 2s View ↗

☁️ Nx Cloud last updated this comment at 2025-01-06 19:23:37 UTC

Copy link

pkg-pr-new bot commented Jan 5, 2025

Open in Stackblitz

More templates

@tanstack/angular-query-devtools-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/angular-query-experimental

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 27d766e

Copy link

codecov bot commented Jan 5, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.29%. Comparing base (80490f1) to head (7af572f).

Additional details and impacted files

Impacted file tree graph

@@                  Coverage Diff                  @@
##           feature/isSubscribed    #8506   +/-   ##
=====================================================
  Coverage                 84.29%   84.29%           
=====================================================
  Files                        26       26           
  Lines                       363      363           
  Branches                    103      102    -1     
=====================================================
  Hits                        306      306           
  Misses                       48       48           
  Partials                      9        9           
Components Coverage Δ
@tanstack/angular-query-devtools-experimental ∅ <ø> (∅)
@tanstack/angular-query-experimental ∅ <ø> (∅)
@tanstack/eslint-plugin-query ∅ <ø> (∅)
@tanstack/query-async-storage-persister ∅ <ø> (∅)
@tanstack/query-broadcast-client-experimental ∅ <ø> (∅)
@tanstack/query-codemods ∅ <ø> (∅)
@tanstack/query-core ∅ <ø> (∅)
@tanstack/query-devtools ∅ <ø> (∅)
@tanstack/query-persist-client-core ∅ <ø> (∅)
@tanstack/query-sync-storage-persister ∅ <ø> (∅)
@tanstack/react-query 95.94% <ø> (ø)
@tanstack/react-query-devtools 10.00% <ø> (ø)
@tanstack/react-query-next-experimental ∅ <ø> (∅)
@tanstack/react-query-persist-client 100.00% <ø> (ø)
@tanstack/solid-query ∅ <ø> (∅)
@tanstack/solid-query-devtools ∅ <ø> (∅)
@tanstack/solid-query-persist-client ∅ <ø> (∅)
@tanstack/svelte-query ∅ <ø> (∅)
@tanstack/svelte-query-devtools ∅ <ø> (∅)
@tanstack/svelte-query-persist-client ∅ <ø> (∅)
@tanstack/vue-query ∅ <ø> (∅)
@tanstack/vue-query-devtools ∅ <ø> (∅)

Copy link
Collaborator

@TkDodo TkDodo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@flodlc
Copy link
Contributor Author

flodlc commented Jan 6, 2025

thanks. do you think this section is still needed ?

I don't think so, it becomes too complexe for a very marginal usecase. Let's remove it!

@hirbod
Copy link
Contributor

hirbod commented Jan 8, 2025

@TkDodo I agree, the section can be removed. The new prop is enough.
Also the section with enabled/disabled could potentially be removed, or just kept as a note next to the subscribed).

subscribed and enabled are technically still different, we should add some info around that topic

@TkDodo TkDodo merged commit 67ac48a into TanStack:feature/isSubscribed Jan 8, 2025
6 checks passed
@TkDodo
Copy link
Collaborator

TkDodo commented Jan 8, 2025

thanks. I think I’ll ship the feature and we can iterate on the docs later too

TkDodo added a commit that referenced this pull request Jan 8, 2025
…the query cache with an option (#8348)

* feat(react-query): allow useQuery and useQueries to unsubscribe from the query cache with an option

* test: subscribed

* fix: revert calling getOptimisticResult later

* docs(react): update the react-native.md section (#8506)

* update the doc

* update the doc

---------

Co-authored-by: Dominik Dorfmeister <[email protected]>

* docs: reference

---------

Co-authored-by: Florian De la comble <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants