fix(types): v2

[wolverineks]

working on updating types for v2

[bespokebob]

Since you're already working on this - MutateOptions is missing throwOnError. Thanks!

[tannerlinsley]

How's it going over here?

[wolverineks]

How's it going over here?

only prefetch and setQueryData remaining

[wolverineks]

i think this has everything except queryCache.prefetchQueries
thats gonna need fresher eyes that i have at the moment

[kizivat]

I wanted to do the queryCache.prefetchQuery but it doesn't seem I can add commits to someone else's PR. So suggested diff:

@@ -612,7 +578,8 @@ export interface QueryCache {
       | undefined
       | (() => TKey | false | null | undefined),
     queryFn: QueryFunction<TResult, TKey>,
-    config?: PrefetchQueryOptions<TResult, TError>
+    config?: QueryOptions<TResult, TError>,
+    options?: PrefetchQueryOptions<TResult, TError>, 
   ): Promise<TResult>
 
   prefetchQuery<TResult, TKey extends string, TError = Error>(
@@ -623,7 +590,8 @@ export interface QueryCache {
       | undefined
       | (() => TKey | false | null | undefined),
     queryFn: QueryFunction<TResult, [TKey]>,
-    config?: PrefetchQueryOptions<TResult, TError>
+    config?: QueryOptions<TResult, TError>,
+    options?: PrefetchQueryOptions<TResult, TError>
   ): Promise<TResult>
 
   prefetchQuery<TResult, TKey extends AnyQueryKey, TError = Error>(
@@ -634,7 +602,8 @@ export interface QueryCache {
       | undefined
       | (() => TKey | false | null | undefined),
     queryFn: QueryFunction<TResult, TKey>,
-    config?: PrefetchQueryOptions<TResult, TError>
+    config?: QueryOptions<TResult, TError>,
+    options?: PrefetchQueryOptions<TResult, TError>
   ): Promise<TResult>
 
   prefetchQuery<TResult, TKey extends string, TError = Error>(
@@ -645,12 +614,12 @@ export interface QueryCache {
       | undefined
       | (() => TKey | false | null | undefined),
     queryFn: QueryFunction<TResult, [TKey]>,
-    config?: PrefetchQueryOptions<TResult, TError>
+    config?: QueryOptions<TResult, TError>,
+    options?: PrefetchQueryOptions<TResult, TError>
   ): Promise<TResult>
 
   prefetchQuery<TResult, TKey extends AnyQueryKey, TError = Error>({
     queryKey,
-
     queryFn,
     config,
   }: {
@@ -661,7 +630,8 @@ export interface QueryCache {
       | undefined
       | (() => TKey | false | null | undefined)
     queryFn: QueryFunction<TResult, TKey>
-    config?: PrefetchQueryOptions<TResult, TError>
+    config?: QueryOptions<TResult, TError>,
+    options?: PrefetchQueryOptions<TResult, TError>
   }): Promise<TResult>

Edit: the diff was in the wrong direction

[kizivat]

I'll open other PR for it, feel free to include it in this one if you'd prefer to keep it under one roof

[wolverineks]

the types for prefetch are in another pr
#633

[tannerlinsley]

You guys could try and use the new github code suggestions for those prefetch types? https://github.blog/2018-10-16-future-of-software/#suggested-changes-public-beta

[kizivat]

You guys could try and use the new github code suggestions for those prefetch types? https://github.blog/2018-10-16-future-of-software/#suggested-changes-public-beta

To do so in this PR we'd need some change in somewhere near those lines of code as it doesn't seem to be possible to add comments/suggestions outside of a narrow context of the changed lines.

[tannerlinsley]

Darn!

[dcastil]

@kizivat You can also open a PR against wolverineks:master to submit your changes. When the PR gets merged, the changes will appear in this PR.

[wolverineks]

😬 maaaaybe?

[kizivat]

So doesn't the queryFn still need to be optional as well?

[wolverineks]

So doesn't the queryFn still need to be optional as well?

i think i misremembered that, it doesnt look like it is optional

[wolverineks]

So doesn't the queryFn still need to be optional as well?

wellp, it is optional,and defaults to config.queryFn
not sure how to make that type safe...

[tannerlinsley]

Is there anything anyone is waiting on me for?

[wolverineks]

ok, dtslint passes

[tannerlinsley]

Cool , you should be able to add dtslint to the test:ci script in the package.json

[tannerlinsley]

Fantastic!

[wolverineks]

i wasnt sure about infiniteQueryWithVariables. this test looks obsolete, maybe?
https://github.com/tannerlinsley/react-query/blob/2767395101642d717af4fe8f1c40d1bbe5e5a03a/types/test.ts#L361

[tannerlinsley]

I think I’d still viable. The variables it is referring to are not the optional variables that were deprecated. I think. 😂

[wolverineks]

I think I’d still viable. The variables it is referring to are not the optional variables that were deprecated. I think. 😂

could you explain a bit? i dont understand what this test is testing.

[tannerlinsley]

You're right. Useless. Get it out of there! ;)

[bugzpodder]

Is this missing a resetErrorBoundaries definition on QueryCache?

[tannerlinsley]

This is looking great. Do you all think these are good enough to release in their current state? Then we can just continue to improve and fix them as we go?

[bugzpodder]

LGTM

[tannerlinsley]

Wow, thanks everyone here for working on this. I appreciate you. If you played any part in these great types, please feel free to open an issue and tag yourself using the all-contributors bot to add yourself to the contributor list.

[tannerlinsley]

🎉 This PR is included in version 2.4.4 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[Ethan-Arrowood]

Congrats on shipping type definitions! I know first hand it is no easy task to author definitions for a JS project 😄 great work!

[johnnyreilly]

Nice work all!

[selbekk]

Fantastic work - thanks for putting in the effort!

[reddevil22]

Thanks for the work, everyone. Definitely looking forward to testing out the new types

[kachkaev]

Many thanks for your work folks! 🎉 I was pretty impatient to try v2 with typings and installed 2.4.4 the first thing this morning 😅

All fits well in the tests project except one small thing in tests:

afterEach(() => {
  queryCache.clear({ notify: false }) // Expected 0 arguments, but got 1.ts(2554)
})

I can imagine a few more small hickups here and there, so wondering what’s the best place to track them. Does every possible error deserves its own PR or should we try collecting a few reports first and mitigate them as a batch?

[MichaelDeBoey]

@kachkaev I think you can just create a PR to fix that typing issue and we can fix them all when we come across them.
That way everybody can enjoy the fixed typings asap 🙂