Remove overloads #4714

Mamoanwar97 · 2022-12-27T22:13:37Z

This PR attempts to fix #4694 of v5 milestones, In this PR:

remove overloads from query-core
remove overloads from react-query
remove overloads from solid-query
remove overloads from vue-query
update tests, docs, and examples accordingly

remove overloads and only allow all functions to be called with a single signature BREAKING CHANGE: Overloads are removed, query-core now supports a single signature

remove overloads and only allow all functions to be called with a single signature BREAKING CHANGE: Overloads are removed, react-query now supports a single signature

remove overloads and only allow all functions to be called with a single signature BREAKING CHANGE: Overloads are removed, solid-query now supports a single signature

remove overloads and only allow all functions to be called with a single signature BREAKING CHANGE: Overloads are removed, vue-query now supports a single signature

…erloads

codesandbox-ci · 2022-12-27T22:14:52Z

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 2bf7484:

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

codecov-commenter · 2022-12-27T22:17:50Z

Codecov Report

❗ No coverage uploaded for pull request base (v5@af2e27e). Click here to learn what that means.
Patch has no changes to coverable lines.

Additional details and impacted files

@@          Coverage Diff          @@
##             v5    #4714   +/-   ##
=====================================
  Coverage      ?   92.30%           
=====================================
  Files         ?       89           
  Lines         ?     3641           
  Branches      ?      949           
=====================================
  Hits          ?     3361           
  Misses        ?      265           
  Partials      ?       15

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

TkDodo

awesome work, this is huge 🙌 . Please have a look at my comments

docs/react/adapters/solid-query.md

TkDodo · 2022-12-28T07:16:14Z

docs/react/adapters/solid-query.md

+  const query = createQuery({ 
+    queryKey: () => ['todos'],
+    queryFn: fetchTodos,
    // ❌ passing a signal directly is not reactive
    // enabled: enabled(),


I think this workaround is also unnecessary without the overloads. @ardeora can you have a look please

docs/react/guides/migrating-to-react-query-5.md

examples/solid/basic-typescript/src/index.tsx

packages/query-core/src/queryClient.ts

packages/react-query/src/types.ts

TkDodo · 2022-12-28T07:43:32Z

packages/solid-query/src/utils.ts

+export function normalizeQueryOptions<T>(arg: T): T {
+  const { queryKey: solidKey, ...opts } = arg as any
+  if (solidKey) {
+    return {
+      ...opts,
+      queryKey: solidKey(),
    }
-    return arg1 as any
-  }
-
-  if (typeof arg2 === 'function') {
-    return { ...arg3, queryKey: arg1(), queryFn: arg2 } as any
  }
-
-  return { ...arg2, queryKey: arg1() } as any
+  return arg as any
 }


not sure if this is still necessary. from what I can see, it tries to make the queryKey reactive ? I guess we'd now want that for the whole options object? Another question for @ardeora :)

packages/solid-query/src/createMutation.ts

packages/vue-query/src/useBaseQuery.ts

… argument BREAKING CHANGE: getQueryData now accepts only queryKey as an argument

…an argument BREAKING CHANGE: getQueryState now accepts only queryKey as an argument

…erloads

TkDodo · 2022-12-31T09:29:51Z

@allcontributors add @Mamoanwar97 for code

allcontributors · 2022-12-31T09:29:53Z

@TkDodo

@Mamoanwar97 already contributed before to code

TkDodo · 2022-12-31T09:31:29Z

@ardeora merged. Please create a follow up PR to address the open solid todos (or just an issue if you'd want someone else to tackle it). @DamianOsipiuk I don't think there is anything open for vue, but if there is, let's also create a follow-up

Mamoanwar97 added 18 commits December 27, 2022 22:17

refactor(query-core): remove overloads

cca39d0

remove overloads and only allow all functions to be called with a single signature BREAKING CHANGE: Overloads are removed, query-core now supports a single signature

test(query-core): apply single signature to all tests

797f2fa

refactor(react-query): remove overloads

54cc996

remove overloads and only allow all functions to be called with a single signature BREAKING CHANGE: Overloads are removed, react-query now supports a single signature

test(react-query): apply single signature to all tests

dd89050

refactor(solid-query): remove overloads

85b6824

remove overloads and only allow all functions to be called with a single signature BREAKING CHANGE: Overloads are removed, solid-query now supports a single signature

test(solid-query): apply single signature to all tests

184020e

refactor(vue-query): remove overloads

7bff740

remove overloads and only allow all functions to be called with a single signature BREAKING CHANGE: Overloads are removed, vue-query now supports a single signature

test(vue-query): apply single signature to all tests

120635a

test(react-query-persist-client): apply single signature to all tests

931d2d0

fix(react-query-devtools): apply single signature to all tests

d60536f

test(react-query-devtools): apply single signature to all tests

055483e

test(query-sync-storage-persister): apply single signature to all tests

eea1f8b

docs: apply object single signature to all docs

66f9dfa

Merge branch 'v5' of https://github.com/TanStack/query into remove-ov…

9d8cd72

…erloads

docs(examples/react): apply object single signature to all examples

c5cc3c2

docs(examples/solid): apply object single signature to all examples

e3c2fbf

docs(examples/vue): apply object single signature to all examples

41a651a

style(examples): run prettier on all files

8568e13

TkDodo reviewed Dec 28, 2022

View reviewed changes

TkDodo requested review from DamianOsipiuk and ardeora December 28, 2022 07:49

Mamoanwar97 added 6 commits December 28, 2022 10:50

docs: use multiline whenever we use the object syntax

807c106

fix(setQueryDefaults): keep it as two arguments

8a9ae6e

fix(createMutation): remove unnecessary shallow copy

6630273

fix(vue-query): rename parseArgs functions to unrefArgs

3ffc6ab

docs(migrating-to-react-query-5): list all affected functions

fcd30e1

fix(setQueryData): remove as alias

3346d5a

Mamoanwar97 force-pushed the remove-overloads branch from b34e4b6 to 3346d5a Compare December 28, 2022 14:23

Mamoanwar97 added 3 commits December 29, 2022 10:27

refactor(getQueryData): getQueryData now supports only queryKey as an…

cd4a3ae

… argument BREAKING CHANGE: getQueryData now accepts only queryKey as an argument

refactor(getQueryState): getQueryState now supports only queryKey as …

c865325

…an argument BREAKING CHANGE: getQueryState now accepts only queryKey as an argument

test(react-query/useQuery): missing single signature

556aedd

TkDodo linked an issue Dec 29, 2022 that may be closed by this pull request

remove overloads #4694

Closed

Merge branch 'v5' into remove-overloads

7534b46

DamianOsipiuk approved these changes Dec 30, 2022

View reviewed changes

Merge branch 'v5' of https://github.com/TanStack/query into remove-ov…

2bf7484

…erloads

ardeora approved these changes Dec 30, 2022

View reviewed changes

TkDodo merged commit eeec5f7 into TanStack:v5 Dec 31, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove overloads #4714

Remove overloads #4714

Mamoanwar97 commented Dec 27, 2022 •

edited

codesandbox-ci bot commented Dec 27, 2022 •

edited

codecov-commenter commented Dec 27, 2022 •

edited

TkDodo left a comment

TkDodo Dec 28, 2022

TkDodo Dec 28, 2022

TkDodo commented Dec 31, 2022

allcontributors bot commented Dec 31, 2022

TkDodo commented Dec 31, 2022

Remove overloads #4714

Remove overloads #4714

Conversation

Mamoanwar97 commented Dec 27, 2022 • edited

codesandbox-ci bot commented Dec 27, 2022 • edited

codecov-commenter commented Dec 27, 2022 • edited

Codecov Report

TkDodo left a comment

Choose a reason for hiding this comment

TkDodo Dec 28, 2022

Choose a reason for hiding this comment

TkDodo Dec 28, 2022

Choose a reason for hiding this comment

TkDodo commented Dec 31, 2022

allcontributors bot commented Dec 31, 2022

TkDodo commented Dec 31, 2022

Mamoanwar97 commented Dec 27, 2022 •

edited

codesandbox-ci bot commented Dec 27, 2022 •

edited

codecov-commenter commented Dec 27, 2022 •

edited