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

fix(angular-query): remove queryClient parameter from callback functions #8307

Merged
merged 1 commit into from
Nov 19, 2024

Conversation

arnoud-dv
Copy link
Collaborator

@arnoud-dv arnoud-dv commented Nov 19, 2024

The queryClient being passed to callback functions of injectMutation and injectQuery is convenient as there's no need for the developer to then inject the queryClient themselves. However it's causing problems with typing.

To get to a stable release removing this parameter for now.

This is a breaking change, if you currently use this functionality please inject the queryClient yourself:

class ComponentOrService {
+  queryClient = inject(QueryClient)

-  mutation = injectMutation((queryClient) => {
-    queryClient.setQueryData(['todos'], (old) => [...old, optimisticTodo])
+  mutation = injectMutation(() => {
+    this.queryClient.setQueryData(['todos'], (old) => [...old, optimisticTodo])
  })
}

Fixes #8042

@github-actions github-actions bot added documentation Improvements or additions to documentation package: angular-query-experimental labels Nov 19, 2024
Copy link

nx-cloud bot commented Nov 19, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 834d96d. 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.

Copy link

pkg-pr-new bot commented Nov 19, 2024

Open in Stackblitz

More templates

@tanstack/angular-query-devtools-experimental

pnpm add https://pkg.pr.new/@tanstack/angular-query-devtools-experimental@8307

@tanstack/eslint-plugin-query

pnpm add https://pkg.pr.new/@tanstack/eslint-plugin-query@8307

@tanstack/query-async-storage-persister

pnpm add https://pkg.pr.new/@tanstack/query-async-storage-persister@8307

@tanstack/angular-query-experimental

pnpm add https://pkg.pr.new/@tanstack/angular-query-experimental@8307

@tanstack/query-broadcast-client-experimental

pnpm add https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@8307

@tanstack/query-core

pnpm add https://pkg.pr.new/@tanstack/query-core@8307

@tanstack/query-devtools

pnpm add https://pkg.pr.new/@tanstack/query-devtools@8307

@tanstack/query-persist-client-core

pnpm add https://pkg.pr.new/@tanstack/query-persist-client-core@8307

@tanstack/query-sync-storage-persister

pnpm add https://pkg.pr.new/@tanstack/query-sync-storage-persister@8307

@tanstack/react-query

pnpm add https://pkg.pr.new/@tanstack/react-query@8307

@tanstack/react-query-devtools

pnpm add https://pkg.pr.new/@tanstack/react-query-devtools@8307

@tanstack/react-query-next-experimental

pnpm add https://pkg.pr.new/@tanstack/react-query-next-experimental@8307

@tanstack/react-query-persist-client

pnpm add https://pkg.pr.new/@tanstack/react-query-persist-client@8307

@tanstack/solid-query

pnpm add https://pkg.pr.new/@tanstack/solid-query@8307

@tanstack/solid-query-devtools

pnpm add https://pkg.pr.new/@tanstack/solid-query-devtools@8307

@tanstack/solid-query-persist-client

pnpm add https://pkg.pr.new/@tanstack/solid-query-persist-client@8307

@tanstack/svelte-query-devtools

pnpm add https://pkg.pr.new/@tanstack/svelte-query-devtools@8307

@tanstack/svelte-query

pnpm add https://pkg.pr.new/@tanstack/svelte-query@8307

@tanstack/svelte-query-persist-client

pnpm add https://pkg.pr.new/@tanstack/svelte-query-persist-client@8307

@tanstack/vue-query-devtools

pnpm add https://pkg.pr.new/@tanstack/vue-query-devtools@8307

@tanstack/vue-query

pnpm add https://pkg.pr.new/@tanstack/vue-query@8307

commit: 834d96d

Copy link

codecov bot commented Nov 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.21%. Comparing base (4a2e838) to head (834d96d).
Report is 5 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #8307       +/-   ##
===========================================
+ Coverage   45.96%   88.21%   +42.24%     
===========================================
  Files         199       17      -182     
  Lines        7501      263     -7238     
  Branches     1717       40     -1677     
===========================================
- Hits         3448      232     -3216     
+ Misses       3676       30     -3646     
+ Partials      377        1      -376     
Components Coverage Δ
@tanstack/angular-query-devtools-experimental ∅ <ø> (∅)
@tanstack/angular-query-experimental 88.21% <100.00%> (-0.05%) ⬇️
@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 ∅ <ø> (∅)
@tanstack/react-query-devtools ∅ <ø> (∅)
@tanstack/react-query-next-experimental ∅ <ø> (∅)
@tanstack/react-query-persist-client ∅ <ø> (∅)
@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 ∅ <ø> (∅)
---- 🚨 Try these New Features:

@arnoud-dv arnoud-dv merged commit 4aff846 into TanStack:main Nov 19, 2024
8 checks passed
@arnoud-dv arnoud-dv deleted the fix/onsuccess-loses-type branch November 19, 2024 18:32
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 package: angular-query-experimental
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Angular injectMutation: onSuccess loses type when queryClient is passed to injectMutation
1 participant